myshows 0.1.0 → 0.1.1

data.tar.gz.sig

@@ -1,2 +1 @@
-A첮
-����Y�!�}�������ӂ�M�u't�7��W�ϴ�%Sf}�C,�u�_LF�>l��wH����3�Vz`��^#�ٍG|p��w�L>6wPrި^[,����`�8FB>FY'=-5�+.�;��p.�q9�8(����^,��pڞ�!B/`����=\��xp�i#<w|����ju�,������M���g�[]����#�>L��er{����tR4*�u��p��m֖#K�}�05��
I0
+Y x�=k:�֟�(=>G�~}z����S�oGc�`w�Wlwn���Լ��~,������K��j����)�h�H�h?;/���|�ˇ6�?�2A�Q0��gQ������њм��4=��ox��

data/Manifest

@@ -1,6 +1,7 @@
 Manifest
-README
+README.rdoc
 Rakefile
+all-api.rb
 lib/myshows.rb
 lib/myshows/api.rb
 lib/myshows/episode.rb

data/README.rdoc

@@ -0,0 +1,41 @@
+== MyShows API
+Object-oriented wrapper over API of http://myshows.ru
+
+=== Usage
+Simply require
+  require 'rubygems'
+  require 'myshows'
+And use
+  # authorization is needed for some features
+  # requires valid login and md5(password)
+  profile = MyShows::Profile.new 'demo', 'fe01ce2a7fbac8fafaed7c982a04e229'
+  profile.shows   # => all user shows
+
+  search = MyShows::Search.new
+  tbbt = search.show("The Big Bang Theory").first
+  tbbt.title      # => "The Big Bang Theory"
+  tbbt.ru_title   # => "Теория большого взрыва"
+  # and many other fields provided by API
+
+  tbbt.episodes   # => [...] - all episodes
+  pilot = tbbt.episode 1, 1
+  pilot.title     # => "Pilot"
+  pilot.show      # => tbbt
+  pilot.air_date  # => "24.09.2007" (fields parsing would be done later)
+  # and many other fields provided by API
+
+  # if you are authorized:
+  pilot.uncheck!  # => this episode would be marked as 'unwatched'
+  pilot.check!    # => this episode would be marked as 'watched'
+
+Look at http://rubydoc.info/gems/myshows/ for detailed documentation
+
+=== Tests
+  rake spec
+
+=== TODO
+- support all API (other user profiles, all unwatched episodes, ...)
+- show and episode fields conversion to Ruby types
+
+=== Author
+Vladimir Parfinenko, write at vladimir[dot]parfinenko[at]gmail[dot]com

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('myshows', '0.1.0') do |p|
+Echoe.new('myshows', '0.1.1') do |p|
   p.summary        = "MyShows API"
   p.description    = "Object-oriented wrapper over API of http://myshows.ru"
   p.url            = "http://github.com/cypok/myshows"

data/lib/myshows.rb

@@ -1,8 +1,8 @@
 $: << File.expand_path(File.dirname(__FILE__))
 
-module MyShows
-  autoload :Profile, 'myshows/profile'
-  autoload :Search, 'myshows/search'
+require 'myshows/profile'
+require 'myshows/search'
 
+module MyShows
   class Error < StandardError; end
 end

data/lib/myshows/api.rb

@@ -4,12 +4,12 @@ require 'crack/json'
 require 'memoize'
 require 'singleton'
 
+require 'myshows/show'
+require 'myshows/episode'
+
 JSON = Crack::JSON
 
 module MyShows
-  autoload :Show, 'myshows/show'
-  autoload :Episode, 'myshows/episode'
-
   class API
     include Singleton
 

data/lib/myshows/episode.rb

@@ -1,6 +1,16 @@
-module MyShows
-  autoload :Item, 'myshows/item'
+require 'myshows/item'
 
+module MyShows
+  # Provides such methods:
+  # title
+  # episode_number
+  # season_number
+  # short_name
+  # air_date
+  # sequence_number
+  # production_number
+  # image
+  # tvrage_link
   class Episode < Item
     attr_reader :show
 
@@ -18,10 +28,14 @@ module MyShows
       "#{show} - #{season_number}x#{episode_number} - #{title}"
     end
 
+    # Check episode as 'watched',
+    # requires authorization via Profile
     def check!
       @api.check_episode self
     end
 
+    # Check episode as 'unwatched',
+    # requires authorization via Profile
     def uncheck!
       @api.uncheck_episode self
     end

data/lib/myshows/profile.rb

@@ -1,14 +1,20 @@
-module MyShows
-  autoload :API, 'myshows/api'
+require 'myshows/api'
 
+module MyShows
+  # Profile initialization is needed to gain access
+  # to some functions of API
   class Profile
 
-    def initialize(login, password)
+    # Login and md5-hashed password of
+    # valid account on myshows.ru
+    def initialize(login, password_md5)
       @api = MyShows::API.instance
 
-      @api.authorize login, password
+      @api.authorize login, password_md5
     end
 
+    # All active, delayed and cancelled shows
+    # of current user
     def shows
       @api.user_shows
     end

data/lib/myshows/search.rb

@@ -1,12 +1,14 @@
-module MyShows
-  autoload :API, 'myshows/api'
+require 'myshows/api'
 
-  # Tools for searching over whole base
+module MyShows
+  # Tools for searching over whole base of myshows.ru
   class Search
     def initialize
       @api = MyShows::API.instance
     end
 
+    # Simple show search by its name,
+    # number of results is limited
     def show(name)
       @api.search_show name
     end

data/lib/myshows/show.rb

@@ -1,5 +1,22 @@
+require 'myshows/item'
+
 module MyShows
-  autoload :Item, 'myshows/item'
+  # Provides such methods:
+  # title
+  # ru_title
+  # rating
+  # country
+  # started
+  # ended
+  # runtime
+  # voted
+  # year
+  # genres
+  # status
+  # watching
+  # imdb_id
+  # tvrage_id
+  # kinopoisk_id
 
   class Show < Item
     def initialize(id, data)
@@ -14,10 +31,12 @@ module MyShows
       title
     end
 
+    # Returns all episodes
     def episodes
       @api.show_episodes self
     end
 
+    # Returns episode by season and episode number
     def episode(season_number, episode_number)
       episodes.detect {|e| e.season_number == season_number && e.episode_number == episode_number }
     end

data/myshows.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{myshows}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vladimir Parfinenko"]
   s.cert_chain = ["/Users/cypok/.gem/gem-public_cert.pem"]
-  s.date = %q{2011-01-25}
+  s.date = %q{2011-01-26}
   s.description = %q{Object-oriented wrapper over API of http://myshows.ru}
   s.email = %q{vladimir.parfinenko@gmail.com}
-  s.extra_rdoc_files = ["README", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb"]
-  s.files = ["Manifest", "README", "Rakefile", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb", "myshows.gemspec", "spec/myshows_spec.rb"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb", "myshows.gemspec", "spec/myshows_spec.rb"]
   s.homepage = %q{http://github.com/cypok/myshows}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Myshows", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Myshows", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{myshows}
   s.rubygems_version = %q{1.4.2}

data/spec/myshows_spec.rb

@@ -1,6 +1,4 @@
 require 'myshows'
-require 'myshows/show'
-require 'myshows/episode'
 
 describe MyShows do
   TBBT = 'The Big Bang Theory'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: myshows
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Vladimir Parfinenko
@@ -36,7 +36,7 @@ cert_chain:
   78F0qvtLjR0DAnN6uYs98PR+jHE+0ckLX3D9sw==
   -----END CERTIFICATE-----
 
-date: 2011-01-25 00:00:00 +06:00
+date: 2011-01-26 00:00:00 +06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,7 +102,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - lib/myshows.rb
 - lib/myshows/api.rb
 - lib/myshows/episode.rb
@@ -112,7 +112,7 @@ extra_rdoc_files:
 - lib/myshows/show.rb
 files: 
 - Manifest
-- README
+- README.rdoc
 - Rakefile
 - lib/myshows.rb
 - lib/myshows/api.rb
@@ -134,7 +134,7 @@ rdoc_options:
 - --title
 - Myshows
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement