yify 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 444df3202b63cbb563862f2f46f4ec751d91c0ca
-  data.tar.gz: a6f427e5350de1647a29f7a02ea32d7dae927dc7
+  metadata.gz: 8f96a332480dd0b6c5883fbc666be0b5be4b9d39
+  data.tar.gz: 37c3caca1ef4112448b3138621803bcffd02ed66
 SHA512:
-  metadata.gz: 8270e6f9d1840c8a606d931b2430ed0c3b69599dd11c8365d1869da3815c70962de79c22423ef99064285a566f121f09221a3379530041189653b093122b1e6a
-  data.tar.gz: 5f338f9040b02b68466caea1b216d9365b3a9aa20648cae84f0b42fe15536dce91131193da8b0eec2ec6575bba82fd5fc7d99972cd0af213c1eb066dd1aa4408
+  metadata.gz: 93cb98f0d25cac232064fa1270b57b9d4027eac81ed4819ff846a61c0e0d30cf427f06ede1c888cee457f4da5f98ea54aa13ee05206da874edaffcf8ab0600fd
+  data.tar.gz: 7abffdb88f928a3bc77e6401c403cb392819e3799a3200f9f8b54503602479554cb1da81105cdbde485d4c8dbab9a23a53156d7abb632e7b6d810ad408f351fd

data/README.md

@@ -8,55 +8,182 @@ A Ruby wrapper for the [Yify Torrents API](https://yts.to/api)
 
 Add this line to your application's Gemfile:
 
-    gem 'yify'
-
+```ruby
+gem 'yify'
+```
 And then execute:
 
-    $ bundle
-
+```ruby
+$ bundle
+```
 Or install it yourself as:
 
-    $ gem install yify
+```ruby
+$ 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_details(353).result
-	=> #<Yify::Models::Movie:0x007f9b14360130>
-
-	movie.movie_title
-	=> "We Were Soldiers (2002)"
+```ruby
+require 'yify'
+```
+
+##### Configuration
+
+If you plan on making POST requests you must provide an `application_key` by
+requesting one [here](https://yts.to/contact). Please note that the email from
+Yify will be in your spam folder 99.9% of the time, so check there :)
+
+You can configure your Yify client by passing in your `application_key` directly,
+like so:
+
+```ruby
+client = Yify::Client.new("1235dsfjkdladfs")
+client.application_key
+=> "1235dsfjkdladfs"
+```
+
+Alternatively you can set a `yify_application_key` environment variable and that
+will be picked up automatically:
+
+```ruby
+ENV["yify_application_key"] = "1235dsfjkdladfs"
+
+client = Yify::Client.new
+client.application_key
+=> "1235dsfjkdladfs"
+```
+
+Now you can make POST requests and the `application_key` will be set for you,
+no need to pass it as a param every time:
+
+```ruby
+client.user_get_key({ username: "hello", password: "world" })
+
+=> #<Yify::Response:0x007f90f512f010
+ @model=:session,
+ @response=
+  {"status"=>"ok",
+   "status_message"=>"User successfully logged in",
+   "data"=>
+    {"user_id"=>123456,
+     "username"=>"hello",
+     "email"=>"hello@world.com",
+     "user_key"=>"12345678910abcdefghij"},
+   "@meta"=>
+    {"server_time"=>1442866362,
+     "server_timezone"=>"Pacific/Auckland",
+     "api_version"=>2,
+     "execution_time"=>"5.02 ms"}},
+ @result=
+  #<Yify::Models::Session:0x007f90f512dd78
+   @attribute_set=#<Virtus::AttributeSet:0x007f90f5132b20>,
+   @email="hello@world.com",
+   @user_id=123456,
+   @user_key="12345678910abcdefghij", # You will need this to make requests on behalf of the user
+   @username="hello">>
+```
+
+##### Example Response
+
+This gem translates the raw JSON coming back from Yify into full fledged Ruby objects, like this:
+
+```ruby
+client = Yify::Client.new
+client.list_upcoming
+client.result
+
+=> [#<Yify::Models::Movie:0x007f88675d27c0
+    @attribute_set=#<Virtus::AttributeSet:0x007f88675cb560>,
+    @date_added="2015-09-22 08:32:41",
+    @date_added_unix=1442867561,
+    @imdb_code="tt2582496",
+    @medium_cover_image=
+     "http://s.ynet.io/assets/images/upcoming/14428675626.jpg",
+    @title="Me and Earl and the Dying Girl",
+    @year=2015>,
+   #<Yify::Models::Movie:0x007f88675b9f40
+    @attribute_set=#<Virtus::AttributeSet:0x007f8867582888>,
+    @date_added="2015-09-19 04:18:56",
+    @date_added_unix=1442593136,
+    @imdb_code="tt0096926",
+    @medium_cover_image=
+     "http://s.ynet.io/assets/images/upcoming/144259313649.jpg",
+    @title="The Big Picture",
+    @year=1989>,
+   #<Yify::Models::Movie:0x007f8867578608
+      ...
+   ]>
+```
 
 A `Yify::Response` will always return an untouched hash as well, like this:
 
-	movie = client.movie_details(353).response
-	=> {"id"=>"353",
- 		"DateUploaded"=>"2011-08-31 01:04:02",
- 		... }
+```ruby
+client = Yify::Client.new
+client.list_upcoming
+client.response
+
+=> {"status"=>"ok",
+   "status_message"=>"Query was successful",
+   "data"=>
+    {"upcoming_movies_count"=>4,
+     "upcoming_movies"=>
+      [{"title"=>"Me and Earl and the Dying Girl",
+        "year"=>2015,
+        "imdb_code"=>"tt2582496",
+        "medium_cover_image"=>
+         "http://s.ynet.io/assets/images/upcoming/14428675626.jpg",
+        "date_added"=>"2015-09-22 08:32:41",
+        "date_added_unix"=>1442867561},
+       {"title"=>"The Big Picture",
+        "year"=>1989,
+        "imdb_code"=>"tt0096926",
+        "medium_cover_image"=>
+         "http://s.ynet.io/assets/images/upcoming/144259313649.jpg",
+        "date_added"=>"2015-09-19 04:18:56",
+        "date_added_unix"=>1442593136}
+        ...
+        ]},
+   "@meta"=>
+    {"server_time"=>1442868382,
+     "server_timezone"=>"Pacific/Auckland",
+     "api_version"=>2,
+     "execution_time"=>"1.62 ms"}},
+```
+
+## API Documentation
 
-	movie["id"]
-	=> "353"
+You can view the full YTS API documentation [here](https://yts.to/api). Every
+request documented is implemented by this gem, please file an issue if you find
+a request that is not implemented.
 
-Note about POST request. You will have to provide your own `application_key` per
-POST request. You can request an `application_key` [here](https://yts.to/contact).
+## Testing
 
+This gem uses [dotenv](https://github.com/bkeepers/dotenv) to manage necessary
+environment variables. After cloning this repo you will need to set the
+following in a `.env` file in the root directory of this gem:
 
-#### API Documentation
+```ruby
+yify_application_key=1234567890asdfg
+user_key=1234567890asdfg
+username=hello_world
+username_variant=hello-world
+password=pass1234
+new_password=pass1234
+email=hello@world.com
+user_id=1234567,
+ip_address=1.2.3.4.5
+reset_code=fdase123
+```
 
-You can view the full YTS API documentation [here](https://yts.to/api). Every
-request documented is implemented by this gem, please file an issue if you find
-a request that is not implemented.
+The values don't matter, this is just so vcr has something to reference when
+filtering out sensitive data from the cassettes.
 
 ## Change Log
 
+- **0.0.4:** Add application_key configuration
 - **0.0.3:** Implement YTS API V2
 - **0.0.2:** Update base_uri from yts.re -> yts.to
 - **0.0.1:** Initial release

data/lib/yify/client.rb

@@ -2,10 +2,18 @@
 
 module Yify
   class Client
+    include Yify::Support::Utils
     include HTTParty
+
+    attr_accessor :application_key
+
     base_uri 'http://yts.to/api/v2'
     format :json
 
+    def initialize(application_key = nil)
+      @application_key = application_key || ENV["yify_application_key"]
+    end
+
     # [GET] list_movies
     # See: https://yts.to/api#list_movies
     #
@@ -149,7 +157,7 @@ module Yify
     # @returns [Yify::Models::Session]
 
     def user_get_key(params)
-      data = self.class.post("/user_get_key", { body: params })
+      data = self.class.post("/user_get_key", { body: post_params(params) })
       Yify::Response.new(data, :session)
     end
 
@@ -183,7 +191,7 @@ module Yify
     # @returns Yify::Models::User
 
     def user_edit_settings(params)
-      data = self.class.post("/user_edit_settings", { body: params })
+      data = self.class.post("/user_edit_settings", { body: post_params(params) })
       Yify::Response.new(data, :user)
     end
 
@@ -201,7 +209,7 @@ module Yify
     # @returns Yify::Models::Session
 
     def user_register(params)
-      data = self.class.post("/user_register", { body: params })
+      data = self.class.post("/user_register", { body: post_params(params) })
       Yify::Response.new(data, :session)
     end
 
@@ -217,7 +225,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def user_forgot_password(params)
-      data = self.class.post("/user_forgot_password", { body: params })
+      data = self.class.post("/user_forgot_password", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -234,7 +242,7 @@ module Yify
     # @returns Yify::Models::Session
 
     def user_reset_password(params)
-      data = self.class.post("/user_reset_password", { body: params })
+      data = self.class.post("/user_reset_password", { body: post_params(params) })
       Yify::Response.new(data, :session)
     end
 
@@ -251,7 +259,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def like_movie(params)
-      data = self.class.post("/like_movie", { body: params })
+      data = self.class.post("/like_movie", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -284,7 +292,7 @@ module Yify
     # @returns Yify::Models::Bookmark
 
     def add_movie_bookmark(params)
-      data = self.class.post("/add_movie_bookmark", { body: params })
+      data = self.class.post("/add_movie_bookmark", { body: post_params(params) })
       Yify::Response.new(data, :bookmark)
     end
 
@@ -301,7 +309,7 @@ module Yify
     # @returns Yify::Models::Bookmark
 
     def delete_movie_bookmark(params)
-      data = self.class.post("/delete_movie_bookmark", { body: params })
+      data = self.class.post("/delete_movie_bookmark", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -319,7 +327,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def make_comment(params)
-      data = self.class.post("/make_comment", { body: params })
+      data = self.class.post("/make_comment", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -336,7 +344,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def like_comment(params)
-      data = self.class.post("/like_comment", { body: params })
+      data = self.class.post("/like_comment", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -353,7 +361,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def report_comment(params)
-      data = self.class.post("/report_comment", { body: params })
+      data = self.class.post("/report_comment", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -370,7 +378,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def delete_comment(params)
-      data = self.class.post("/delete_comment", { body: params })
+      data = self.class.post("/delete_comment", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 
@@ -388,7 +396,7 @@ module Yify
     # @returns Yify::Models::ApiResponse
 
     def make_request(params)
-      data = self.class.post("/make_request", { body: params })
+      data = self.class.post("/make_request", { body: post_params(params) })
       Yify::Response.new(data, :api_response)
     end
 

data/lib/yify/support/utils.rb

@@ -48,6 +48,11 @@ module Yify
         end
       end
 
+      def post_params(params)
+        params[:application_key] = @application_key unless @application_key.nil?
+        params
+      end
+
     end
   end
 end

data/lib/yify/version.rb

@@ -1,3 +1,3 @@
 module Yify
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/yify_spec.rb

@@ -10,6 +10,16 @@ describe Yify::Client do
     expect(subject.class.base_uri).to eq("http://yts.to/api/v2")
   end
 
+  it "should set an application_key" do
+    client = Yify::Client.new(ENV["application_key"])
+    expect(client.application_key).to eq(ENV["application_key"])
+  end
+
+  it "should set an application_key from an ENV variable" do
+    client = Yify::Client.new
+    expect(client.application_key).to eq(ENV["application_key"])
+  end
+
   it "should list movies", :vcr do
     response = subject.list_movies({ limit: 3 })
     expect(response.result.count).to eq(3)
@@ -98,7 +108,7 @@ describe Yify::Client do
   end
 
   it "should add a movie bookmark", :vcr do
-    params = { application_key: ENV["application_key"], user_key: ENV["user_key"], movie_id: 353 }
+    params = { user_key: ENV["user_key"], movie_id: 353 }
     request = subject.add_movie_bookmark(params)
     expect(request.response["status_message"]).to eq("Movie has been successfully bookmarked")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jon Lunsford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-20 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: YIFY Torrents API