memo_rage 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.redcar
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in memo_rage.gemspec
+gemspec

data/README.md

@@ -0,0 +1,26 @@
+# Memo Rage #
+
+Memo rage is an api wrapper for the http://services.tvrage.com/
+The gem is created to fulfil the needs of the project http://watchmemo.com
+
+## Installation ##
+
+gem install memo_rage
+
+## How to use it? ##
+
+First you have to create a client with your api key
+
+    client = MemoRage::Client.new(:key => "abcd1234")
+
+You can search tv shows with
+
+    client.search("NAME OF THE TV SHOW")
+
+Get show info with
+
+    client.show_info("THE ID OF THE SHOW")
+
+Get show episode list
+
+    client.episode_list("THE ID OF THE SHOW")

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/memo_rage/client.rb

@@ -0,0 +1,40 @@
+module MemoRage
+  class Client
+    attr_reader :params
+    
+    def initialize(options)
+      @params = { :key => options[:key] }
+    end
+    
+    def search(query)
+      content = get("search", { :show => query })
+      parser = MemoRage::Parser::ShowSearch.new content
+      parser.parse
+    end
+    
+    def show_info(id)
+      content = get("showinfo", { :sid => id })
+      parser = MemoRage::Parser::ShowInfo.new content
+      parser.parse
+    end
+
+    def episode_list(id)
+      content = get("episode_list", { :sid => id })
+      parser = MemoRage::Parser::EpisodeList.new content
+      parser.parse        
+    end
+
+    private
+    def get(path, params = {})
+      HTTPClient.get build_endpoint(path), build_params(params)
+    end
+    
+    def build_params(params = {})
+      @params.merge(params)
+    end
+    
+    def build_endpoint(path)
+      File.join(MemoRage::ROOT_URL, "#{path}.php")
+    end
+  end
+end

data/lib/memo_rage/episode.rb

@@ -0,0 +1,13 @@
+module MemoRage
+  class Episode < Node
+    attr_reader :num
+    attr_reader :season
+    attr_reader :season_num
+    attr_reader :prod_num
+    attr_reader :airdate
+    attr_reader :link
+    attr_reader :title
+    attr_reader :rating
+    attr_reader :image
+  end
+end

data/lib/memo_rage/node.rb

@@ -0,0 +1,12 @@
+module MemoRage
+  class Node
+    def initialize (params)
+      return if params.nil?
+
+      params.each do |key, value|
+        name = key.to_s
+        instance_variable_set("@#{name}", value) if respond_to?(name)
+      end
+    end
+  end
+end

data/lib/memo_rage/parser/base.rb

@@ -0,0 +1,21 @@
+module MemoRage
+  module Parser
+    class Base
+      def initialize(content)
+        @content = content
+      end
+      
+      def parse
+        parse_content @content
+      end
+
+      def form_array(entry)
+        output = []
+        entry.elements.each do |text|
+            output << text.text
+        end
+        output
+      end
+    end
+  end
+end

data/lib/memo_rage/parser/episode_list.rb

@@ -0,0 +1,44 @@
+module MemoRage
+  module Parser
+    class EpisodeList < Base
+      def parse_content(content)
+        doc = REXML::Document.new(content.body)
+        list = doc.elements["Show"]
+
+        unless list == "0"
+          parse_entry(list)
+        end
+      end
+      
+      def parse_entry(entry)
+        episodes = []
+        season_number = 0
+        entry.elements["Episodelist"].elements.each("Season") do |season|
+          season_number += 1
+          season.elements.each("episode") do |episode|
+            if episode.elements["screencap"] == nil
+                missing = episode.add_element "screencap"
+                missing.add_text ""
+            end
+            episodes << MemoRage::Episode.new(
+              :num => episode.elements["epnum"].text,
+              :season => season_number,
+              :season_num => episode.elements["seasonnum"].text,
+              :prod_num => episode.elements["prodnum"].text,
+              :airdate => episode.elements["airdate"].text,
+              :link => episode.elements["link"].text,
+              :title => episode.elements["title"].text,
+              :rating => episode.elements["rating"].text,
+              :image => episode.elements["screencap"].text
+            )
+          end
+        end
+        MemoRage::Show.new(
+          :name => entry.elements["name"].text,
+          :seasons => entry.elements["totalseasons"].text.to_i,
+          :episodes => episodes
+        )
+      end
+    end
+  end
+end

data/lib/memo_rage/parser/show_info.rb

@@ -0,0 +1,36 @@
+module MemoRage
+  module Parser
+    class ShowInfo < Base
+      def parse_content(content)
+        doc = REXML::Document.new(content.body)
+        showinfo = doc.elements["Showinfo"]
+
+        unless showinfo == "0"
+          parse_entry(showinfo)
+        end
+      end
+
+      def parse_entry(entry)
+        MemoRage::Show.new(
+          :id => entry.elements["showid"].text.to_i,
+          :name => entry.elements["showname"].text,
+          :link => entry.elements["showlink"].text,
+          :seasons => entry.elements["seasons"].text.to_i,
+          :image => entry.elements["image"].text,
+          :started => entry.elements["started"].text,
+          :ended => entry.elements["ended"].text,
+          :origin_country => entry.elements["origin_country"].text,
+          :status => entry.elements["status"].text,
+          :classification => entry.elements["classification"].text,
+          :genres => form_array(entry.elements["genres"]),
+          :runtime => entry.elements["runtime"].text.to_i,
+          :airtime => entry.elements["airtime"].text,
+          :airday => entry.elements["airday"].text,
+          :timezone => entry.elements["timezone"].text,
+          :akas => form_array(entry.elements["akas"])
+        )
+      end
+
+    end
+  end
+end

data/lib/memo_rage/parser/show_search.rb

@@ -0,0 +1,26 @@
+module MemoRage
+  module Parser
+    class ShowSearch < Base
+      def parse_content(content)
+        doc = REXML::Document.new(content.body)
+        results = doc.elements["Results"]
+
+        shows = []
+        unless results == "0"
+          results.elements.each("show") do |show|
+            shows << parse_entry(show)
+          end
+        end
+        
+        shows
+      end
+      
+      def parse_entry(entry)
+        MemoRage::Show.new(
+          :id => entry.elements["showid"].text.to_i,
+          :name => entry.elements["name"].text
+        )
+      end
+    end
+  end
+end

data/lib/memo_rage/parser.rb

@@ -0,0 +1,4 @@
+require "memo_rage/parser/base"
+require "memo_rage/parser/show_search"
+require "memo_rage/parser/show_info"
+require "memo_rage/parser/episode_list"

data/lib/memo_rage/show.rb

@@ -0,0 +1,24 @@
+module MemoRage
+  class Show < Node
+    attr_reader :id
+    attr_reader :name
+    attr_reader :link
+    attr_reader :seasons
+    attr_reader :image
+    attr_reader :started
+    attr_reader :ended
+    attr_reader :startdate
+    attr_reader :origin_country
+    attr_reader :status
+    attr_reader :classification
+    attr_reader :runtime
+    attr_reader :airtime
+    attr_reader :airday
+    attr_reader :timezone
+    attr_reader :seasons
+    
+    attr_reader :genres # Array
+    attr_reader :akas # Array
+    attr_reader :episodes # Array
+  end
+end

data/lib/memo_rage/version.rb

@@ -0,0 +1,3 @@
+module MemoRage
+  VERSION = "0.0.1"
+end

data/lib/memo_rage.rb

@@ -0,0 +1,13 @@
+require "httpclient"
+require "rexml/document"
+require "memo_rage/version"
+
+module MemoRage
+  ROOT_URL = "http://services.tvrage.com/myfeeds"
+end
+
+require "memo_rage/node"
+require "memo_rage/show"
+require "memo_rage/episode"
+require "memo_rage/client"
+require "memo_rage/parser"

data/memo_rage.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "memo_rage/version"
+
+Gem::Specification.new do |s|
+  s.name        = "memo_rage"
+  s.version     = MemoRage::VERSION
+  s.authors     = ["Alex Ganov", "Todor Grudev"]
+  s.email       = ["aganov@gmail.com", "tagrudev@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Memo rage is an api wrapper for the http://services.tvrage.com/ The gem is created to fulfil the needs of the project http://watchmemo.com}
+  s.description = %q{Find more information at https://github.com/appsbakery/memo_rage}
+
+  s.rubyforge_project = "memo_rage"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency "httpclient", ">= 2.2.0.2"
+  s.add_runtime_dependency "hashie", ">= 1.1.0"
+  s.add_development_dependency "rake", ">= 0.8.7"
+  s.add_development_dependency "rspec", ">= 2"
+  s.add_development_dependency "webmock", ">= 1.6.2"
+  s.add_development_dependency "timecop", ">= 0.3.5"
+end

data/spec/helpers/webmock_helper.rb

@@ -0,0 +1,73 @@
+require 'webmock/rspec'
+
+module WebMockHelper
+  
+  # Mock http request with webmock
+  #
+  # @param [Symbol] method http method
+  # @param [String] path endpoint path
+  # @param [String] response_file json response file name/path
+  # @param [Hash] options optional options params
+  def mock_api(method, path, response_file, options = {})
+    stub_request(method, endpoint_for(path)).with(
+      request_for(method, options)
+    ).to_return(
+      response_for(response_file, options)
+    )
+    
+    yield
+  end
+  
+  # Load json response file and return its content
+  #
+  # @param [String] response_file json response file name/path
+  # @return [String]
+  def load_json(response_file)
+    File.new(File.join(File.dirname(__FILE__), '../mock_xml', "#{response_file}.xml"))
+  end
+
+  private
+  
+  # Get final url for specific endpoint
+  #
+  # @param [String] path is the endpoint path ex: `showinfo`
+  # @return [String] the formatted endpoint, if anonymize is enabled prefixed with anonymous
+  def endpoint_for(path)
+    File.join(MemoRage::ROOT_URL, "#{path}.php")
+  end
+  
+  # Prepare request params for HTTPClient
+  #
+  # @param [Symbol] http method
+  # @param [Hash] options like params, etc
+  # @return [Hash] formatted http request hash
+  def request_for(method, options = {})
+    request = {}
+    if options[:params]
+      case method
+      when :post, :put
+        request[:body] = options[:params]
+      else
+        request[:query] = options[:params]
+      end
+    end
+    request
+  end
+  
+  # Build response hash for HTTPClient
+  #
+  # @param [String] response_file json response file name/path
+  # @param [Hash] options like status, etc
+  # @return [Hash] formatted http response hash
+  def response_for(response_file, options = {})
+    response = {}
+    response[:body] = load_json(response_file)
+    if options[:status]
+      response[:status] = options[:status]
+    end
+    response
+  end
+end
+
+include WebMockHelper
+WebMock.disable_net_connect!

data/spec/memo_rage/client_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MemoRage::Client do
+  let(:client) { MemoRage::Client.new(:key => 'abcd1234') }
+  
+  describe '#build_params' do
+    it 'should merge provided params with api key' do
+      params = client.send :build_params, { :show => 'buffy' }
+      params[:key].should == 'abcd1234'
+      params[:show].should == 'buffy'
+    end
+  end
+  
+  describe '#build_endpoint' do
+    it 'should merge path with root url' do
+      client.send(:build_endpoint, 'search').should == "http://services.tvrage.com/myfeeds/search.php"
+      client.send(:build_endpoint, 'showinfo').should == "http://services.tvrage.com/myfeeds/showinfo.php"
+    end
+  end
+end

data/spec/memo_rage/parser/episode_list_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe MemoRage::Parser::EpisodeList do
+  let(:client) { MemoRage::Client.new(:key => "abcd1234") }
+  
+  it 'should be awesome' do
+    mock_api :get, 'episode_list', 'episode_list', :params => client.params.merge(:sid => "2930") do
+      list = client.episode_list("2930")
+      list.name.should == "Buffy the Vampire Slayer"
+      list.seasons.should == 7
+    end
+  end
+end

data/spec/memo_rage/parser/show_info_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe MemoRage::Parser::ShowInfo do
+  let(:client) { MemoRage::Client.new(:key => "abcd1234") }
+  
+  it 'should be awesome' do
+    mock_api :get, 'showinfo', 'show_info', :params => client.params.merge(:sid => "2930") do
+      show = client.show_info("2930")
+      show.id.should == 2930
+      show.name.should == "Buffy the Vampire Slayer"
+      show.link.should == "http://www.tvrage.com/Buffy_The_Vampire_Slayer"
+      show.seasons.should == 7
+      show.image.should == "http://images.tvrage.com/shows/3/2930.jpg"
+      show.started.should == "1997"
+      show.origin_country.should == "US" 
+      show.status.should == "Canceled/Ended"
+      show.classification.should == "Scripted"
+      show.genres.should =~ [ "Action", "Adventure", "Comedy", "Drama", "Mystery", "Sci-Fi" ]
+      show.runtime.should == 60
+      show.airtime.should == "20:00" 
+      show.airday.should == "Tuesday"
+      show.timezone == "GMT-5 -DST"
+      show.akas =~ [ "Buffy & vampyrerna", "Buffy - Im Bann der Dämonen", "Buffy - Vampyrenes skrekk", "Buffy a vámpírok réme", "Buffy Contre les Vampires", "Buffy l'Ammazza Vampiri", "Buffy postrach wampirów", "Buffy, a Caça-Vampiros", "Buffy, a Caçadora de Vampiros", "Buffy, Cazavampiros", "Buffy, ubojica vampira", "Buffy, vampyyrintappaja", "Vampiiritapja Buffy", "Vampírubaninn Buffy" ]
+    end
+  end
+end
+

data/spec/memo_rage/parser/show_search_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe MemoRage::Parser::ShowSearch do
+  let(:client) { MemoRage::Client.new(:key => "abcd1234") }
+  
+  it 'should be awesome' do
+    mock_api :get, 'search', 'show_search', :params => client.params.merge(:show => "buffy") do
+      show = client.search("buffy").first
+      show.id.should == 2930
+      show.name.should == "Buffy the Vampire Slayer"
+    end
+  end
+end