rovi_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9401ed99a00eebb434a037bdde2122fe86a876ba
+  data.tar.gz: cf9b9b340eb89a7ebc92e5c200ada4ac80332c17
+SHA512:
+  metadata.gz: 04c2a9867584e9139cb09ec228d2ad332d830b6c5d9843c8f2e36c14563eae15c56590d5d36b07376d117d7b7316c09dca8150aa1d9428c95509cdbb9cb9fc54
+  data.tar.gz: 94680137d304ba42e748215ccbcaafc485bc833668f22dcc482dbfd732916f0e75c3be453ccccfcfe833c06aa47277b63ea16f2ed834d2c37dcea9750f32ef2f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,40 @@
+# RoviAPI
+
+A basic wrapper for the Rovi Data and Search APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rovi_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rovi_api
+
+## Usage
+
+```ruby
+r = RoviAPI::Client.new(key: "your-key", secret: "your-secret")
+r.client.data.name.info(name: "Artist Name")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/quadule/rovi_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "dotenv"
+Dotenv.load
+
+require "rovi_api"
+r = RoviAPI.client
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rovi_api.rb

@@ -0,0 +1,38 @@
+require "faraday"
+require "faraday_middleware"
+
+require_relative "rovi_api/client"
+require_relative "rovi_api/endpoint"
+require_relative "rovi_api/service"
+require_relative "rovi_api/version"
+require_relative "rovi_api/endpoints/album"
+require_relative "rovi_api/endpoints/music"
+require_relative "rovi_api/endpoints/name"
+require_relative "rovi_api/endpoints/song"
+require_relative "rovi_api/services/data"
+require_relative "rovi_api/services/search"
+
+module RoviAPI
+  class << self
+    attr_accessor :host, :key, :secret
+  end
+
+  self.host   = ENV["ROVI_API_HOST"] || "http://api.rovicorp.com"
+  self.key    = ENV["ROVI_API_KEY"]
+  self.secret = ENV["ROVI_API_SECRET"]
+
+  def self.client
+    raise "RoviAPI.key and RoviAPI.secret must be set" unless key && secret
+    @client ||= Client.new
+  end
+
+  def self.connection
+    Faraday.new(host) do |c|
+      c.adapter Faraday.default_adapter
+      c.headers["Accept"] = "application/json"
+      c.response :rashify
+      c.response :raise_error
+      c.response :json, content_type: /\bjson$/
+    end
+  end
+end

data/lib/rovi_api/client.rb

@@ -0,0 +1,42 @@
+module RoviAPI
+  class Client
+    attr_reader :connection, :last_response
+
+    def initialize(key: RoviAPI.key, secret: RoviAPI.secret, connection: RoviAPI.connection)
+      @key = key or raise ArgumentError("missing key")
+      @secret = secret or raise ArgumentError("missing secret")
+      @connection = connection
+    end
+
+    def data
+      @data ||= Services::Data.new(self)
+    end
+
+    def search
+      @search ||= Services::Search.new(self)
+    end
+
+    def get(service, version, endpoint, method, params={})
+      path = [service, version, endpoint, method].join("/")
+      begin
+        @last_response = @connection.get(path, default_params.merge(params))
+      rescue ::Faraday::ClientError => ex
+        @last_response = ex.response
+        raise
+      end
+      @last_response.body
+    end
+
+    def default_params
+      { apikey: @key, sig: signature }
+    end
+
+    def signature
+      Digest::MD5.hexdigest(@key + @secret + Time.now.to_i.to_s)
+    end
+
+    def inspect
+      "<#{self.class} @key=#{@key.inspect}>"
+    end
+  end
+end

data/lib/rovi_api/endpoint.rb

@@ -0,0 +1,9 @@
+module RoviAPI
+  class Endpoint
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+    end
+  end
+end

data/lib/rovi_api/endpoints/album.rb

@@ -0,0 +1,13 @@
+module RoviAPI
+  module Endpoints
+    class Album < Endpoint
+      def get(method, params={})
+        @service.get(:album, method, params)
+      end
+
+      def info(params={})
+        get(:info, params).album
+      end
+    end
+  end
+end

data/lib/rovi_api/endpoints/music.rb

@@ -0,0 +1,42 @@
+require "fuzzy_match"
+
+module RoviAPI
+  module Endpoints
+    class Music < Endpoint
+      def get(method, params={})
+        @service.get(:music, method, params)
+      end
+
+      def find(member, query, params={})
+        results = search(params.merge(query: query)).map(&member)
+        return [] if results.empty?
+
+        match_key = results[0].has_key?("title") ? :title : :name
+        matcher = FuzzyMatch.new(results, read: match_key, must_match_at_least_one_word: true)
+        result = matcher.find(query)
+
+        if result
+          results.unshift(results.delete(result))
+        else
+          []
+        end
+      end
+
+      def search(params={})
+        get(:search, params).search_response.results || []
+      end
+
+      def album(query, params={})
+        find(:album, query, params.merge(entitytype: "album"))
+      end
+
+      def artist(query, params={})
+        find(:name, query, params.merge(entitytype: "artist"))
+      end
+
+      def song(query, params={})
+        find(:song, query, params.merge(entitytype: "song"))
+      end
+    end
+  end
+end

data/lib/rovi_api/endpoints/name.rb

@@ -0,0 +1,13 @@
+module RoviAPI
+  module Endpoints
+    class Name < Endpoint
+      def get(method, params={})
+        @service.get(:name, method, params)
+      end
+
+      def info(params={})
+        get(:info, params).name
+      end
+    end
+  end
+end

data/lib/rovi_api/endpoints/song.rb

@@ -0,0 +1,13 @@
+module RoviAPI
+  module Endpoints
+    class Song < Endpoint
+      def get(method, params={})
+        @service.get(:song, method, params)
+      end
+
+      def info(params={})
+        get(:info, params).song
+      end
+    end
+  end
+end

data/lib/rovi_api/service.rb

@@ -0,0 +1,9 @@
+module RoviAPI
+  class Service
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/rovi_api/services/data.rb

@@ -0,0 +1,21 @@
+module RoviAPI
+  module Services
+    class Data < Service
+      def get(endpoint, method, params={})
+        @client.get(:data, :"v1.1", endpoint, method, params)
+      end
+
+      def album
+        @album ||= Endpoints::Album.new(self)
+      end
+
+      def name
+        @name ||= Endpoints::Name.new(self)
+      end
+
+      def song
+        @song ||= Endpoints::Song.new(self)
+      end
+    end
+  end
+end

data/lib/rovi_api/services/recs.rb

@@ -0,0 +1,9 @@
+module RoviAPI
+  module Services
+    class Recs < Service
+      def get(endpoint, method, params={})
+        @client.get(:recs, :"v2.1", endpoint, method, params)
+      end
+    end
+  end
+end

data/lib/rovi_api/services/search.rb

@@ -0,0 +1,13 @@
+module RoviAPI
+  module Services
+    class Search < Service
+      def get(endpoint, method, params={})
+        @client.get(:search, :"v2.1", endpoint, method, params)
+      end
+
+      def music
+        @music ||= Endpoints::Music.new(self)
+      end
+    end
+  end
+end

data/lib/rovi_api/version.rb

@@ -0,0 +1,3 @@
+module RoviAPI
+  VERSION = "0.1.0"
+end

data/rovi_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rovi_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rovi_api"
+  spec.version       = RoviAPI::VERSION
+  spec.authors       = ["Milo Winningham"]
+  spec.email         = ["milo@winningham.net"]
+
+  spec.summary       = %q{Reads music data from the Rovi API.}
+  spec.homepage      = "https://github.com/quadule/rovi_api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "fuzzy_match", "~> 2.1"
+  spec.add_dependency "rash", ">= 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: rovi_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Milo Winningham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: fuzzy_match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- milo@winningham.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rovi_api.rb
+- lib/rovi_api/client.rb
+- lib/rovi_api/endpoint.rb
+- lib/rovi_api/endpoints/album.rb
+- lib/rovi_api/endpoints/music.rb
+- lib/rovi_api/endpoints/name.rb
+- lib/rovi_api/endpoints/song.rb
+- lib/rovi_api/service.rb
+- lib/rovi_api/services/data.rb
+- lib/rovi_api/services/recs.rb
+- lib/rovi_api/services/search.rb
+- lib/rovi_api/version.rb
+- rovi_api.gemspec
+homepage: https://github.com/quadule/rovi_api
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Reads music data from the Rovi API.
+test_files: []