yify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d979512449ef590614706d2f76342aca3142e2b5
+  data.tar.gz: 5ea8fd1e035bc1c3b3050c590560ce5d6b7a499b
+SHA512:
+  metadata.gz: 4eedc326e2b9d72049582ec9952d81e2a779a4c758d4395c8d7fa42c832980cb346b2eeea7a59029ab9c6b33f261bdc90b7dbb402f6947219170227267e82448
+  data.tar.gz: 5e510d4fc9eb94465e60d0f22bbc920045a622d0c5c52569f52ecf4a79a3a9a4374d8a799bef3688d439bf5e569afb936516d1360fcebe40489e98aee826897f

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yify.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jon Lunsford
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,276 @@
+# Yify
+
+A Ruby wrapper for the [Yify torrenst API](http://yify-torrents.com/api/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yify
+
+## Usage;
+
+Require Yify in your project:
+
+	require 'yify'
+
+This gem translates the raw JSON coming back from Yify into full fledged Ruby objects. This means you can access properties like this:
+	
+	client = Yify::Client.new
+	=> #<Yify::Client:0x007f9b14321ef8>
+	
+	movie = client.movie(353).result
+	=> #<Yify::Models::Movie:0x007f9b14360130>
+	
+	movie.movie_title
+	=> "We Were Soldiers (2002)"
+	
+A `Yify::Response` will always return an untouched hash as well, like this:
+	
+	movie = client.movie(353).response
+	=> {"MovieID"=>"353",
+ 		"MovieUrl"=>"http://yts.re/movie/We_Were_Soldiers_2002",
+ 		"DateUploaded"=>"2011-08-31 01:04:02",
+ 		... }
+	
+	movie["MovieID"]
+	=> "353"
+
+#### Upcoming Movies, [yify docs](http://yify-torrents.com/api/#upcomingDocs)
+
+Get a list of all upcoming movies.
+	
+	client = Yify::Client.new
+	movies = client.upcoming.result
+
+#### List Movies, [yify docs](http://yify-torrents.com/api/#listDocs)
+
+Get a list of movies, this can also be used to search or filter all movies on Yify.
+
+	params = { limit: 50, quality: 720 }
+	client = Yify::Client.new
+	movies = client.list(params).result
+	
+Available request parameters:
+
+Parameter |required | Default | Description
+----------|---------|---------|----
+`limit`   | **no**  |20       |Determines the max amount of movie results
+`set`     | **no**  |1        |Used to see the next set of movies, eg limit=15 and set=2 will show you movies 15-30
+`quality` | **no**  |ALL      |Ability to select a quality type to filter by
+`rating`  | **no**  |0        |Sets minimum movie rating for display
+`keywords`| **no**  |         |Matching keywords title search, IMDB code, Actor Name/IMDB code or Director Name/IMDB code
+`genre`   | **no**  | ALL     |Display movies from chosen type genre
+`sort`    | **no**  | date    |Sorts the results by choose method
+`order`   | **no**  | desc    |Orders the results with either ascending or descending
+
+#### List Movies By IMDB ID, [yify docs](http://yify-torrents.com/api/#listimdbDocs)
+
+Get a list of movies based on IMDB IDs.
+
+	params = { imdb_id: ["tt0111161", "tt0068646"] }
+	client = Yify::Client.new
+	movies = client.list_imdb(params).result
+	
+Available request parameters:
+
+Parameter |required  | Default | Description
+----------|----------|---------|----
+`imdb_id` | **yes**  |         |he input IMDB IDs to retrieve the movies for
+
+#### Movie Details, [yify docs](http://yify-torrents.com/api/#movieDocs)
+
+Get an individual movie.
+
+	client = Yify::Client.new
+	movie = client.movie(353).result
+	
+Available request parameters:
+
+Parameter |required  | Default | Description
+----------|----------|---------|----
+`id`      | **yes**  |         |View full details of specified MovieID
+
+#### Movie Comments, [yify docs](http://yify-torrents.com/api/#commentDocs)
+
+Get all comments related to a movie.
+
+	client = Yify::Client.new
+	comments = client.comments(353).results
+
+Available request parameters:
+
+Parameter |required  | Default | Description
+----------|----------|---------|----
+`movieid` | **yes**  |         |View full list of comments for specified film
+
+#### User Details, [yify docs](http://yify-torrents.com/api/#userDocs)
+
+Get details for specified user.
+
+	client = Yify::Client.new
+	user = client.user(16).results
+
+Available request parameters:
+
+Parameter |required  | Default | Description
+----------|----------|---------|----
+`id`      | **yes**  |         |The unique userID that we want to see the info for
+
+#### Registration, [yify docs](http://yify-torrents.com/api/#registerDocs)
+
+Register a new user. Upon successful registration a confirmation email will be sent.
+
+    params = { username: "my_user", password: "test1234", email: "me@me.com" }
+    client = Yify::Client.new
+    client.register(params)
+
+Available request parameters:
+
+Parameter |required  | Description
+----------|----------|-------------
+`username`| **yes**  |The username of the desired account
+`password`| **yes**  |The username of the desired account
+`email`   | **yes**  |The email address for verification
+
+#### Password Recovery, [yify docs](http://yify-torrents.com/api/#passRecoveryDoc)
+
+Ask Yify for a password recovery email.
+
+	client = Yify::Client.new
+	client.send_password_reset("me@me.com")
+	
+Available request parameters:
+
+Parameter |required  | Description
+----------|----------|-------------
+`email`   | **yes**  |The email address that was registered with the account to send recovery code to
+
+#### Resetting Password, [yify docs](http://yify-torrents.com/api/#resetPasswordDocs)
+
+Send the new password to Yify.
+	
+	params = { code: "xxxxxxxxxx", newpassword: "MyPassword" }
+	client = Yify::Client.new
+	client.reset_password(params)
+	
+Available request parameters:
+
+Parameter    |required  | Description
+-------------|----------|-------------
+`code`       | **yes**  |The password reset code from email
+`newpassword`| **yes**  |The new desired password for the account
+
+#### Login, [yify docs](http://yify-torrents.com/api/#loginDocs)
+
+Login a user.
+
+	params = { username: "username", password: "password" }
+	client = Yify::Client.new
+	client.login(params)
+
+The result of this call will be a Yify::Models::Session object that will store the returned user hash from Yify.
+
+Available request parameters:
+
+Parameter |required  | Description
+----------|----------|-------------
+`username`| **yes**  |The username of the desired account
+`password`| **yes**  |The username of the desired account
+
+#### Profile, [yify docs](https://yts.re/api#profileDocs)
+
+Get details about a users' profile.
+
+	client = Yify::Client.new
+	profile = client.profile(hash_returned_from_the_login_call)
+	
+Available request parameters:
+
+Parameter |required  | Description
+----------|----------|-------------
+`hash`    | **yes**  |The unique hash that will be used as a means of authentication
+
+#### Edit Profile, [yify docs](https://yts.re/api#editProfileDocs)
+
+Edit a users' profile.
+
+    params = { hash: hash_returned_from_the_login_call, about: "RUBY FTW!" }
+    client = Yify::Client.new
+    client.update_profile(params)
+    
+Available request parameters:
+
+Parameter     |required  | Description
+--------------|----------|-------------
+`hash`        | **yes**  |The unique hash that will be used as a means of authentication
+`active`      | **no**   |By default all profiles are showing and active(1), 0 will make them hidden
+`about`       | **no**   |Text describing the user in a short paragraph
+`new password` | **no**   |The new desired password (required 'oldpassword' for confirmation)
+`old password` | **no**   |The old password as confirmation
+`avatar`      | **no**   |This will be the newest avatar image for the user
+
+#### Requests, [yify docs](https://yts.re/api#requestsDocs)
+
+Get a list of all currently requested movies.
+
+    params = { page: "confirmed", limit: 2 }
+    client = Yifi::Client.new
+    requests = client.requests(params)
+    
+    
+Available request parameters:
+
+Parameter     |required  | Description
+--------------|----------|-------------
+`page`        | **yes**  |'accepted' or 'confirmed'. Gives the choice to view the currently open movies for voting and the confirmed movies to be done
+`limit`       | **no**   |Determines the max amount of request results
+`set`         | **no**   |set to see the next set of movies, eg limit=15 and set=2 will show you movies 15-30
+`sort`        | **no**   |Sorts the results by choose method
+`order`       | **no**   |Orders the results with either ascending or descending
+
+#### Make Request, [yify docs](https://yts.re/api#makerequestsDocs)
+
+Send a movie request to Yify.
+	
+    params = { hash: hash_returned_from_the_login_call, request: "tt0111161" }
+    client - Yify::Client.new
+    client.make_request(params)
+    
+Available request parameters:
+
+Parameter     |required  | Description
+--------------|----------|-------------
+`hash`        | **yes**  |The unique hash that will be used as a means of authentication
+`request`     | **yes**  |Request input can be: Movie name or IMDB Code or IMDB URL
+
+#### Vote, [yify docs](https://yts.re/api#voteDocs)
+
+Vote for a requested movie.
+
+    params = { hash: hash_returned_from_the_login_call, requestid: 1169 }
+    client = Yify::Client.new
+    client.vote(params)
+    
+Available request parameters:
+
+Parameter     |required  | Description
+--------------|----------|-------------
+`hash`        | **yes**  |The unique hash that will be used as a means of authentication
+`requested`   | **yes**  |The request ID you wish to vote on
+
+## Contributing
+
+1. Fork it ( https://github.com/jonlunsford/yify/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'dotenv/tasks'
+
+# Helper Functions
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+# Standard tasks
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console => :dotenv do
+  sh "pry -Ilib -r #{name}.rb"
+end

data/lib/yify.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+require 'dotenv'
+require 'yify/support/utils.rb'
+require 'yify/models/base.rb'
+require 'yify/models/movie.rb'
+require 'yify/models/upcoming_movie.rb'
+require 'yify/models/requested_movie.rb'
+require 'yify/models/comment.rb'
+require 'yify/models/user.rb'
+require 'yify/models/profile.rb'
+require 'yify/models/api_response.rb'
+require 'yify/models/session.rb'
+require 'yify/response'
+require 'yify/client'
+
+Dotenv.load
+
+module Yify
+  autoload :VERSION, File.join(File.dirname(__FILE__), 'yify/version');
+end

data/lib/yify/client.rb

@@ -0,0 +1,184 @@
+# A ruby wrapper for the YIFY Torrents API (https://yts.re/api)
+
+module Yify
+  class Client
+    include HTTParty
+    base_uri 'http://yts.re/api'
+    format :json
+
+    # [GET] upcoming
+    # See: https://yts.re/api#upcomingDocs
+    #
+    # A list of all upcoming movies.
+    #
+    # @returns [Yify::Models::UpcomingMovie]
+    def upcoming
+      data = self.class.get("/upcoming")
+      Yify::Response.new(data, :upcoming_movie)
+    end
+
+    # [GET] list
+    # See: https://yts.re/api#listDocs
+    #
+    # Get a list of movies, this method can be used to search
+    # or filter.
+    #
+    # @returns [Yify::Models::Movie]
+    def list(options)
+      data = self.class.get("/list", { query: options })
+      Yify::Response.new(data, :movie_list)
+    end
+
+    # [GET] list_imbd
+    # See: https://yts.re/api#listimdbDocs
+    #
+    # Get a list of movies using a desired list of IMDB IDs.
+    #
+    # @returns [Yify::Models::Movie]
+    def list_imdb(options)
+      data = self.class.get("/listimdb", { query: options })
+      Yify::Response.new(data, :movie_list)
+    end
+
+    # [GET] movie
+    # See: https://yts.re/api#movieDocs
+    #
+    # Get movie details.
+    #
+    # @returns Yify::Models::Movie
+    def movie(id)
+      data = self.class.get("/movie", { query: { id: id } })
+      Yify::Response.new(data, :movie)
+    end
+
+    # [GET] comments
+    # See: https://yts.re/api#commentDocs
+    #
+    # Get comments for the desired movie
+    #
+    # @returns [Yify::Models::Comment]
+    def comments(movie_id)
+      data = self.class.get("/comments", { query: { movieid: movie_id } })
+      Yify::Response.new(data, :comment)
+    end
+
+    # [POST] post_comment
+    # See: https://yts.re/api#commentpostDocs
+    #
+    # Add comment to a movie.
+    #
+    # @returns Yify::Models::ApiResponse
+    def post_comment(options)
+      data = self.class.post("/commentpost", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [GET] user
+    # See: https://yts.re/api#userDocs
+    #
+    # Get desired users' details.
+    #
+    # @returns Yify::Models::User
+    def user(user_id)
+      data = self.class.get("/user", { query: { id: user_id } })
+      Yify::Response.new(data, :user)
+    end
+
+    # [POST] register
+    # See: https://yts.re/api#registerDocs
+    #
+    # Register a new user with Yify.
+    #
+    # @returns Yify::Models::ApiResponse
+    def register(options)
+      data = self.class.post("/register", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [POST] login
+    # See: https://yts.re/api#loginDocs
+    #
+    # Login a Yify user.
+    #
+    # @returns Yify::Models::Session
+    def login(options)
+      data = self.class.post("/login", { body: options })
+      Yify::Response.new(data, :session)
+    end
+
+    # [POST] send_password_reset
+    # https://yts.re/api#passRecoveryDoc
+    #
+    # Send a password reset email to the specified email address.
+    #
+    # @returns Yify::Models::ApiResponse
+    def send_password_reset(email)
+      data = self.class.post("/sendresetpass", { body: { email: email } })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [POST] reset_password
+    # See: https://yts.re/api#resetPasswordDocs
+    #
+    # Reset the users' password.
+    def reset_password(options)
+      data = self.class.post("/resetpassconfirm", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [GET] profile
+    # See: https://yts.re/api#profileDocs
+    #
+    # Get a logged in users' profile.
+    #
+    # @returns Yify::Models::Profile
+    def profile(hash)
+      data = self.class.get("/profile", { query: { hash: hash } })
+      Yify::Response.new(data, :profile)
+    end
+
+    # [POST] update_profile
+    # See: https://yts.re/api#editProfileDocs
+    #
+    # update a logged in users' profile.
+    #
+    # @returns Yify::Models::ApiResponse
+    def update_profile(options)
+      data = self.class.post("/editprofile", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [GET] requests
+    # See: https://yts.re/api#requestsDocs
+    #
+    # Get a list of all requested movies.
+    #
+    # @returns [Yify::Models::RequestedMovie]
+    def requests(options)
+      data = self.class.get("/requests", { query: options })
+      Yify::Response.new(data, :request_list)
+    end
+
+    # [POST] make_request
+    # See: https://yts.re/api#makerequestsDocs
+    #
+    # Request a movie to be added to Yify.
+    #
+    # @returns Yify::Models::ApiResponse
+    def make_request(options)
+      data = self.class.post("/makerequest", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+
+    # [POST] vote
+    # See: https://yts.re/api#voteDocs
+    #
+    # Vote for a requested movie.
+    #
+    # @returns Yify::Models::ApiResponse
+    def vote(options)
+      data = self.class.post("/vote", { body: options })
+      Yify::Response.new(data, :api_response)
+    end
+  end
+end