rovi 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGRhZTM0YmE4Y2JlMWU5ZDJjOTc3ZTYzMTIyNWExY2VkOTRlNDNkMw==
+  data.tar.gz: !binary |-
+    OWM1Y2IzZGU4NWViMjI3MDQ4NDZhODcyMDJhZmQxYjNiOWI5NGE2Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2FjZjViMTc3ZjI1YjBhOWViYmY5ZmQ4MzgzMWYzOWU0NDBmYmFmZGY0Mzky
+    OGYxMzMyOTk5YjM5ZTE0MjkyMmFjMGExMDJhNGQyZTFhOTkxNGRiYWE0ZmE1
+    ODBhYTEzMzE2ZjJmMDYyOTQyY2NjMTNlOGViMWRhNDljZjQxYzU=
+  data.tar.gz: !binary |-
+    ZGJjNWUyNTBhMzYyNDMyZWYyYjFlZmNlMmI1M2U4MjNhODJjZWU0YmFlMDhi
+    NWY5MmZlYmI1ODcxM2YxMzM3NGMzYWM3NTk3MDlmNzE1ZTQwYjliZjk0Zjc2
+    YjY3NTRlOWVmMjI0ZGNlMTUzM2Q4YTM1NTBlM2YzMDg4YjEzZjM=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'httparty'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "timecop"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.2)
+    multi_xml (0.4.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty
+  jeweler (~> 1.8.3)
+  mocha
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  timecop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dan Garland
+
+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.rdoc

@@ -0,0 +1,19 @@
+= rovi
+
+Description goes here.
+
+== Contributing to rovi
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Dan Garland. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rovi"
+  gem.homepage = "http://github.com/dmgarland/rovi"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem for consuming the Rovi metadata API}
+  gem.description = %Q{A gem for well, consuming the Rovi metadata API}
+  gem.email = "dan@dangarland.co.uk"
+  gem.authors = ["Dan Garland"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rovi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rovi.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+require 'digest/md5'
+
+require_relative 'rovi/api'
+require_relative 'rovi/services/recommendations'
+require_relative 'rovi/services/search'

data/lib/rovi/api.rb

@@ -0,0 +1,44 @@
+module Rovi
+
+  class Api
+    include HTTParty
+
+    disable_rails_query_string_format
+    format :json
+    base_uri "http://api.rovicorp.com"
+    default_params format: 'json', country: 'US', language: 'en'
+
+    def initialize(api_key, api_secret)
+      @api_key, @api_secret = api_key, api_secret
+      @version = "v1"
+      @service_name = "data"
+    end
+
+    def get(category, method, params = {})
+      params.merge!(required_params)
+      options = self.class.default_options.dup.merge!({
+        query: params
+      })
+      path = build_path(category, method)
+
+      response = self.class.get(path, options)
+      response.parsed_response
+    end
+
+    private
+
+    def build_path(category, method)
+      ["", @service_name, @version, category, method].join("/")
+    end
+
+    def required_params
+      { :apikey => @api_key, :sig => generate_sig }
+    end
+
+    def generate_sig
+      Digest::MD5.hexdigest(@api_key + @api_secret + Time.now.to_i.to_s)
+    end
+
+  end
+
+end

data/lib/rovi/response.rb

@@ -0,0 +1,24 @@
+module Rovi
+  class Response
+
+    def initialize(data = {})
+      @data = data
+    end
+
+    def success?
+      @data['status']
+    end
+
+    def method_missing(m)
+      key = m.to_s
+      if @hash != nil and @hash.has_key?(key)
+        v = @hash[key]
+        v = JsonResponse.new(v) if v.is_a?(Hash)
+        return v
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/rovi/services/recommendations.rb

@@ -0,0 +1,13 @@
+module Rovi
+  module Services
+    class Recommendations < Rovi::Api
+      
+      def initialize(api_key, api_secret)
+        super(api_key, api_secret)
+        @service_name = "recs"
+        @version = "v2"
+      end
+      
+    end    
+  end
+end

data/lib/rovi/services/search.rb

@@ -0,0 +1,13 @@
+module Rovi
+  module Services
+    class Search < Rovi::Api
+
+      def initialize(api_key, api_secret)
+        super(api_key, api_secret)
+        @service_name = "search"
+        @version = "v2.1"
+      end
+
+    end
+  end
+end

data/rovi.gemspec

@@ -0,0 +1,29 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rovi"
+  s.version = "0.0.1"
+
+  s.authors = ["Dan Garland"]
+  s.date = "2012-04-24"
+  s.description = "A gem for well, consuming the Rovi metadata API"
+  s.email = "dan@dangarland.co.uk"
+
+  s.files         = `git ls-files`.split($/)
+  s.homepage = "http://github.com/dmgarland/rovi"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.summary = "A gem for consuming the Rovi metadata API"
+
+
+  s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+  s.add_development_dependency(%q<timecop>, [">= 0"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+  s.add_dependency(%q<httparty>, [">= 0"])
+
+end
+

data/spec/lib/api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Rovi::Api do
+  
+  describe "A call to the data service album info endpoint" do
+    before do
+      params = {
+        :albumid => "MW0000111184" 
+      }
+      
+      Timecop.freeze(Time.local(2012, 1, 1)) do
+        @api = Rovi::Api.new("12345", "54321")
+      end
+    end
+    
+    after do
+      Timecop.return
+    end
+    
+    it 'should know the right endpoint for the data service' do
+      @api.instance_variable_set(:@api_function, "album")
+      @api.instance_variable_set(:@api_function_request, "info")
+      @api.send(:endpoint).should == "http://api.rovicorp.com/data/v1/album/info"
+    end
+    
+    it 'should calculate the sig from the MD5 of the access key, secret and the current unix time' do
+      Timecop.freeze(Time.local(2012, 1, 1)) do
+        @api.send(:generate_sig).should == "0ff3ae460b0f7d821482204ca70c8fe8"
+      end
+    end
+  
+    describe 'GET the response from the API' do
+      before do
+        mock_response = mock()
+        mock_response.expects(:parsed_response).returns({ "value" => { "nested" =>  "hi" }})        
+        
+        Rovi::Api.expects(:get).with('http://api.rovicorp.com/data/v1/album/info', { 
+        :query => { :albumid => 'MW0000111184', :apikey => '12345', 
+        :sig => '0ff3ae460b0f7d821482204ca70c8fe8'}}).returns(mock_response)
+
+        Timecop.freeze(Time.local(2012, 1, 1)) do
+          @response = @api.get("album", "info", { :albumid => "MW0000111184" })
+        end
+      end
+      
+      it "should return a JsonResponse wrapper" do
+        @response.is_a?(Rovi::JsonResponse).should == true
+      end
+      
+      it "should access hash keys using methods" do
+        @response.value.nested.should == "hi"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rovi'
+require 'timecop'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rovi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Garland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem for well, consuming the Rovi metadata API
+email: dan@dangarland.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rovi.rb
+- lib/rovi/api.rb
+- lib/rovi/response.rb
+- lib/rovi/services/recommendations.rb
+- lib/rovi/services/search.rb
+- rovi.gemspec
+- spec/lib/api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dmgarland/rovi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: A gem for consuming the Rovi metadata API
+test_files: []