tvrage_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f915d2a0d1255f5d8185be941412f209d833f95
-  data.tar.gz: 1d5ee554e1768a81e3dadae6832ec055ed6192b2
+  metadata.gz: 94940bd48b406bc923d98a10f40bf37e3b88eb41
+  data.tar.gz: a874fa0a2f8b0624ff74e6ff591db98753e63155
 SHA512:
-  metadata.gz: f1c24dd87ee9f99d00668ed53ef11fd64bdf175e43d89d289123121d8a7bcd1f459ff5dc3ad145e97f51f9c717b50ad432462342c7c833a8cb363a5db24408a7
-  data.tar.gz: e78253e1311d7f92f3f951910912abb5b88fd618a26bbbe68b84d0d77f620df26e21bd0107a4f2755317bcc869c1377ccca6a4452c04b0c491fe72637d3c4a31
+  metadata.gz: 97c7a32f883b7be3ea42c0a9145e543e1ab1277add7492ec6e90b86704a4c6b7d91e8d0e2520e43f540e06070095221d7b82ccbd1b457e6f1ada3848da2cbed9
+  data.tar.gz: 58bc4b8aba59140e3d758ebd0d393eda81478d20b5d5e6ae33849c3f00a19882e889998dbe5d5f0b0bd1b6ba41a45dc2d610d172f58b64d0ad3ce56145c73e1a

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -3,4 +3,5 @@ script: 'bundle exec rspec spec/functionals'
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.5
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+## 0.3.0 (January 25, 2015)
+
+  - use ov gem for multimethod
+  - use hashie for normalize params key names
+
+## 0.2.1 (August 31, 2014)
+
+  - update dependencies
+  - fill documentations
+
+## 0.2.0 (June 25, 2014)
+
+  - replaced HTTParty by Faraday
+  - refactored Mapper classes
+
+## 0.1.1 (December 14, 2013)
+
+  - refactored
+
+## 0.1.0 (December 10, 2013)
+
+  - removed monkey patches for Ruby Core Date Types
+  - removed mapping response to objects
+  - little performance improvement
+
+## 0.0.2 (December 7, 2013)
+
+  - corrected README
+
+## 0.0.1 (December 7, 2013)
+
+First release with HTTParty

data/README.md

@@ -1,7 +1,7 @@
-[![Build Status](https://travis-ci.org/wafcio/tvrage_api.png?branch=master)](https://travis-ci.org/wafcio/tvrage_api)
-[![Dependency Status](https://gemnasium.com/wafcio/tvrage_api.png)](https://gemnasium.com/wafcio/tvrage_api)
-[![Code Climate](https://codeclimate.com/github/wafcio/tvrage_api.png)](https://codeclimate.com/github/wafcio/tvrage_api)
-[![Coverage Status](https://coveralls.io/repos/wafcio/tvrage_api/badge.png)](https://coveralls.io/r/wafcio/tvrage_api)
+[![Build Status](https://travis-ci.org/tvapi/tvrage_api.png?branch=master)](https://travis-ci.org/tvapi/tvrage_api)
+[![Dependency Status](https://gemnasium.com/tvapi/tvrage_api.png)](https://gemnasium.com/tvapi/tvrage_api)
+[![Code Climate](https://codeclimate.com/github/tvapi/tvrage_api.png)](https://codeclimate.com/github/tvapi/tvrage_api)
+[![Coverage Status](https://coveralls.io/repos/tvapi/tvrage_api/badge.png)](https://coveralls.io/r/tvapi/tvrage_api)
 [![Gem Version](https://badge.fury.io/rb/tvrage_api.png)](http://badge.fury.io/rb/tvrage_api)
 
 # TvrageApi
@@ -23,105 +23,89 @@ You have two way for access to api:
 
 * I way (create client class, one entry point)
 
-* II way (direct access to api class, many entry points)
-
-Search show by name:
-
 ```ruby
 client = TvrageApi::Client.new
-client.search.by_name(show: 'buffy')
-client.search.full_by_name(show: 'buffy')
+client.info # => #<TvrageApi::Info>
+client.recap # => #<TvrageApi::Recap>
+client.schedule # => #<TvrageApi::Schedule>
+client.search # => #<TvrageApi::Search>
+client.show # => #<TvrageApi::Show>
+client.update # => #<TvrageApi::Update>
 ```
 
+* II way (direct access to api class, many entry points)
+
 ```ruby
-search = TvrageApi::Search.new
-search.by_name(show: 'buffy')
-search.full_by_name(show: 'buffy')
+TvrageApi::Info.new
+TvrageApi::Recap.new
+TvrageApi::Schedule.new
+TvrageApi::Search.new
+TvrageApi::Show.new
+TvrageApi::Update.new
 ```
 
-Search show by id:
+## Methods
 
-```ruby
-client = TvrageApi::Client.new
-client.show.find(sid: '123')
-client.show.find_full(sid: '123')
-client.show.episodes(sid: '123') # show with all episodes
-client.show.episode(sid: '123', ep: 'SEASONxEPISODE') # show with specific episode
-client.show.all
-```
+For almost all method you can pass hash attributes or multiple attributes specified in method comment.
 
-```ruby
-show = TvrageApi::Show.new
-show.find(sid: '123')
-show.find_full(sid: '123')
-show.episodes(sid: '123') # show with all episodes
-show.episode(sid: '123', ep: 'SEASONxEPISODE') # show with specific episode
-show.all
-```
+### Info (QuickInfo) methods
 
-QuickInfo (it return plain text, not parsed)
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/info.rb
 
-```ruby
-client = TvrageApi::Client.new
-client.info.find(show: 'Alias') # main information
-client.info.find(show: 'Alias', ep: '2x04') # episode information
-client.info.find(show: 'Alias', exact: 1) # exact information
-```
+* find
+* find_url
 
-```ruby
-info = TvrageApi::Info.new
-info.find(show: 'Alias') # main information
-info.find(show: 'Alias', ep: '2x04') # episode information
-info.find(show: 'Alias', exact: 1) # exact information
-```
+### Recap methods
 
-Schedule (quick method return plain text)
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/recap.rb
 
-```ruby
-client = TvrageApi::Client.new
-client.schedule.quick
-client.schedule.full(country: 'US')
-```
+* all
+* all_url
+* show
+* show_url
+* last
+* last_url
 
-```ruby
-schedule = TvrageApi::Schedule.new
-schedule.quick
-schedule.full(country: 'US')
-```
+### Schedule methods
 
-Recaps
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/schedule.rb
 
-```ruby
-client = TvrageApi::Client.new
-client.recap.all
-client.recap.show(show: 5410)
-client.recap.last(days: 100)
-```
+* quick
+* quick_url
+* full
+* full_url
 
-```ruby
-recaps = TvrageApi::Recaps.new
-recap.all
-recap.show(show: 5410)
-recap.last(days: 100)
-```
+### Search methods
 
-Updates:
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/search.rb
 
-```ruby
-client = TvrageApi::Client.new
-client.update.last # last 24 hours
-client.update.last(hours: 48) # set timeline (default: 48)
-client.update.last(sort: 'episodes') # only shows where episodes have changed
-client.update.last(since: 1403668430) # updates since last visit
-```
+* by_name
+* by_name_url
+* full_by_name
+* full_by_name_url
 
-```ruby
-update = TvrageApi::Update.new
-update.last # last 24 hours
-update.last(hours: 48) # set timeline (default: 48)
-update.last(sort: 'episodes') # only shows where episodes have changed
-update.last(since: 1403668430) # updates since last visit
-```
+### Show (search show) methods
+
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/show.rb
+
+* find
+* find_url
+* find_full
+* find_full_url
+* episodes
+* episodes_url
+* episode
+* episode_url
+* all
+* all_url
+
+
+### Update methods
+
+For method attributes read https://github.com/tvapi/tvrage_api/blob/master/lib/tvrage_api/update.rb
+
+* last
+* last_url
 
 ## Contributing
 

data/lib/tvrage_api.rb

@@ -1,7 +1,17 @@
+require 'ov'
+
 module TvrageApi
-  module Request; end
+  module AttributesMapping
+    module Recap; end
+    module Search; end
+    module Show; end
+  end
 end
 
+require 'tvrage_api/attributes_mapping/recap/show'
+require 'tvrage_api/attributes_mapping/search/by_name'
+require 'tvrage_api/attributes_mapping/show/episode'
+require 'tvrage_api/attributes_mapping/show/find'
 require 'tvrage_api/version'
 require 'tvrage_api/client'
 require 'tvrage_api/base'

data/lib/tvrage_api/attributes_mapping/recap/show.rb

@@ -0,0 +1,5 @@
+require 'hashie'
+
+class TvrageApi::AttributesMapping::Recap::Show < Hashie::Trash
+  property :show, from: :id
+end

data/lib/tvrage_api/attributes_mapping/search/by_name.rb

@@ -0,0 +1,5 @@
+require 'hashie'
+
+class TvrageApi::AttributesMapping::Search::ByName < Hashie::Trash
+  property :show, from: :name
+end

data/lib/tvrage_api/attributes_mapping/show/episode.rb

@@ -0,0 +1,6 @@
+require 'hashie'
+
+class TvrageApi::AttributesMapping::Show::Episode < Hashie::Trash
+  property :sid, from: :show_id
+  property :ep, from: :episode
+end

data/lib/tvrage_api/attributes_mapping/show/find.rb

@@ -0,0 +1,5 @@
+require 'hashie'
+
+class TvrageApi::AttributesMapping::Show::Find < Hashie::Trash
+  property :sid, from: :id
+end

data/lib/tvrage_api/info.rb

@@ -1,25 +1,65 @@
 class TvrageApi::Info < TvrageApi::Base
+  include Ov
+
+  # Quick information about tv show
+  #
+  # access: FREE
+  # param:
+  #   find('buffy')
+  # output: Faraday::Response instance with string
+  let :find, String do |show|
+    find(show: show)
+  end
+
+  # Quick information about tv show
+  #
+  # access: FREE
+  # param:
+  #   find('buffy', episode: '1x01')
+  #   find('buffy', exact: 1)
+  # output: Faraday::Response instance with string
+  let :find, String, Hash do |show, optional_options|
+    find(optional_options.merge(show: show))
+  end
+
   # Quick information about tv show
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
-  #   ep: episode name, format [Season Number]x[Episode Number, with zero at the beginning for 1-9] (optional)
-  #   exact: 1, Only shows that match exactly will be given.
+  # param:
+  #   find(show: 'buffy')
   # output: Faraday::Response instance with string
-  def find(options = {})
+  let :find, Hash do |options|
     find_path_with_params(options).get
   end
 
   # Quick information about tv show - return only url
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
-  #   ep: episode name, format [Season Number]x[Episode Number, with zero at the beginning for 1-9] (optional)
-  #   exact: 1, Only shows that match exactly will be given.
+  # param:
+  #   find_url('buffy')
+  # output: url string
+  let :find_url, String do |show|
+    find_url(show: show)
+  end
+
+  # Quick information about tv show - return only url
+  #
+  # access: FREE
+  # param:
+  #   find_url('buffy', episode: '1x01')
+  #   find_url('buffy', exact: 1)
+  # output: url string
+  let :find_url, String, Hash do |show, optional_options|
+    find_url(optional_options.merge(show: show))
+  end
+
+  # Quick information about tv show - return only url
+  #
+  # access: FREE
+  # param:
+  #   find_url(show: 'buffy')
   # output: url string
-  def find_url(options = {})
+  let :find_url, Hash do |options|
     find_path_with_params(options).url
   end
 

data/lib/tvrage_api/recap.rb

@@ -1,4 +1,6 @@
 class TvrageApi::Recap < TvrageApi::Base
+  include Ov
+
   # All recaps
   #
   # access: FREE
@@ -18,40 +20,80 @@ class TvrageApi::Recap < TvrageApi::Base
   # Recaps From Selected Show
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show ID
+  # param:
+  #   show('1234')
+  # output: Faraday::Response instance with parsed XML string
+  let :show, Any do |id|
+    show(id: id)
+  end
+
+  # Recaps From Selected Show
+  #
+  # access: FREE
+  # param:
+  #   show(id: '1234')
   # output: Faraday::Response instance with parsed XML string
-  def show(options = {})
+  let :show, Hash do |options|
     show_path_with_params(options).get
   end
 
   # Recaps From Selected Show - return only url
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show ID
+  # param:
+  #   show_url(1234)
   # output: url string
-  def show_url(options = {})
+  let :show_url, Any do |id|
+    show_url(id: id)
+  end
+
+  # Recaps From Selected Show - return only url
+  #
+  # access: FREE
+  # param:
+  #   show_url(id: 1234)
+  # output: url string
+  let :show_url, Hash do |options|
     show_path_with_params(options).url
   end
 
   # Latest Recaps
   #
   # access: FREE
-  # param: options hash
-  #   days: last x days (default 30)
+  # param:
+  #   last(30)
   # output: Faraday::Response instance with parsed XML string
-  def last(options = {})
+  let :last, Any do |days|
+    last(days: days)
+  end
+
+  # Latest Recaps
+  #
+  # access: FREE
+  # param:
+  #   last(days: 30)
+  # output: Faraday::Response instance with parsed XML string
+  let :last, Hash do |options|
     last_path_with_params(options).get
   end
 
   # Latest Recaps - return only url
   #
   # access: FREE
-  # param: options hash
-  #   days: last x days (default 30)
+  # param:
+  #   last_url(30)
   # output: url string
-  def last_url(options = {})
+  let :last_url, Any do |days|
+    last_url(days: days)
+  end
+
+  # Latest Recaps - return only url
+  #
+  # access: FREE
+  # param:
+  #   last_url(days: 30)
+  # output: url string
+  let :last_url, Hash do |options|
     last_path_with_params(options).url
   end
 
@@ -62,7 +104,11 @@ class TvrageApi::Recap < TvrageApi::Base
   end
 
   def show_path_with_params(options)
-    path(show_path).params(options)
+    path(show_path).params(show_mapped_options(options))
+  end
+
+  def show_mapped_options(options)
+    TvrageApi::AttributesMapping::Recap::Show.new(options).to_hash
   end
 
   def show_path