Files
moviehash/README.md
2024-11-29 01:13:26 +00:00

40 lines
1.5 KiB
Markdown

# Moviehash
This is an implementation of [OpenSubtitle's Moviehash](https://trac.opensubtitles.org/projects/opensubtitles/wiki/HashSourceCodes$0)
```ruby
Moviehash.compute_hash("test/files/breakdance.avi")
=> "8e245d9679d31e12"
```
When computing the hash of a file on the web, only the required bytes are downloaded, using HTTP's Range requests
```ruby
# via the web - run this in the console to test:
# ruby -run -e httpd test/files -p 8000
Moviehash.compute_hash("http://localhost:8000/breakdance.avi")
=> "8e245d9679d31e12"
```
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add moviehash
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install moviehash
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/moviehash.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).