nokia_music 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Anderson
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# NokiaMusic
+
+A simple ruby wrapper around the Nokia Music API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nokia_music'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nokia_music
+
+## Usage
+
+Set your client_id:
+
+    NokiaMusic.client_id = ""
+
+Search for music:
+
+    tracks = NokiaMusic.search("Knights of Cydonia", NokiaMusic::Product::TRACK)
+    
+Get either an artist, album, track, or single from an ID
+
+    product = NokiaMusic.product(tracks.items.first.id)
+
+Get a track sample from an ID:
+
+    preview = NokiaMusic.product_sample(id)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/nokia_music.rb

@@ -0,0 +1,34 @@
+require 'faraday_middleware'
+require "nokia_music/version"
+require 'nokia_music/configuration'
+require 'nokia_music/client'
+
+module NokiaMusic
+  extend Configuration
+  
+  mattr_accessor :client_id
+
+  # Alias for NokiaMusic::Client.new
+  #
+  # @return [NokiaMusic::Client]
+  def self.client(options={})
+    NokiaMusic::Client.new(options)
+  end
+
+  # Alias for NokiaMusic::Client.new
+  #
+  # @return [NokiaMusic::Client]
+  def self.new(options={})
+    NokiaMusic::Client.new(options)
+  end
+
+  # Delegate to NokiaMusic::Client
+  def self.method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private = false)
+    new.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/lib/nokia_music/client.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../request', __FILE__)
+
+module NokiaMusic
+  class Client
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new Client
+    def initialize(options={})
+      options = NokiaMusic.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    alias :api_endpoint :endpoint
+
+    include Request
+    include Search
+    include Product
+    include ProductSample
+  end
+end

data/lib/nokia_music/client/product.rb

@@ -0,0 +1,20 @@
+module NokiaMusic
+  module Product
+    
+    ARTIST  = "artist"
+    ALBUM   = "album"
+    SINGLE  = "single"
+    TRACK   = "track"
+
+    def product(id, options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      request("products/#{id}", params)
+    end
+    
+  end
+end

data/lib/nokia_music/client/product_sample.rb

@@ -0,0 +1,10 @@
+module NokiaMusic
+  module ProductSample
+
+    def product_sample(product_id)
+      request = construct_request("products/#{product_id}/sample")
+      Hashie::Mash.new(product_id: product_id, url: "#{request[:url]}?#{request[:params].to_query}")
+    end
+    
+  end
+end

data/lib/nokia_music/client/search.rb

@@ -0,0 +1,15 @@
+module NokiaMusic
+  module Search
+
+    def search(query, category, options={})
+      params = {q: query, category: category}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      request('', params)
+    end
+
+  end
+end

data/lib/nokia_music/configuration.rb

@@ -0,0 +1,66 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module NokiaMusic
+  # Defines constants and methods related to configuration
+  module Configuration
+
+    # An array of valid keys in the options hash when configuring
+    VALID_OPTIONS_KEYS = [:adapter, :endpoint, :itemsperpage, :user_agent, :request_options].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'http://api.ent.nokia.com/1.x'.freeze
+
+    # The country code that will be used if none is set
+    DEFAULT_COUNTRY_CODE = 'us'.freeze
+    
+    # The domain that sill be used if none is set
+    DEFAULT_DOMAIN = 'music'.freeze
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Nokia Music Ruby Gem #{NokiaMusic::VERSION}".freeze
+
+    # The default number of results to return from the API
+    DEFAULT_ITEMSPERPAGE = nil
+
+    # The default request options for Faraday
+    DEFAULT_REQUEST_OPTIONS = {
+      :timeout => 5,
+      :open_timeout => 5
+    }
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter          = DEFAULT_ADAPTER
+      self.endpoint         = DEFAULT_ENDPOINT
+      self.user_agent       = DEFAULT_USER_AGENT
+      self.request_options  = DEFAULT_REQUEST_OPTIONS
+      self.itemsperpage     = DEFAULT_ITEMSPERPAGE
+    end
+  end
+end

data/lib/nokia_music/request.rb

@@ -0,0 +1,38 @@
+module NokiaMusic
+  module Request
+    
+    # @private
+    private
+
+    # Perform an HTTP GET request
+    def request(resource_path, params = {})
+      request = construct_request(resource_path, params)
+
+      response = connection.get do |req|
+        req.url request[:url], request[:params]
+        req.options = request_options
+      end
+      response.body
+    end
+    
+    def construct_request(resource_path, params={})
+      request = {}
+      request[:url] = "#{Configuration::DEFAULT_ENDPOINT}/#{Configuration::DEFAULT_COUNTRY_CODE}/#{resource_path}"
+      request[:params] = params.merge({client_id: NokiaMusic.client_id, domain: Configuration::DEFAULT_DOMAIN})  
+      request    
+    end
+
+    def connection
+      options = {
+        :headers => {'Accept' => 'application/json', 'User-Agent' => user_agent},
+        :url => api_endpoint,
+      }
+
+      Faraday.new(options) do |builder|
+        builder.use Faraday::Response::Rashify
+        builder.use Faraday::Response::ParseJson
+        builder.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/nokia_music/version.rb

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

data/nokia_music.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nokia_music/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "nokia_music"
+  gem.version       = NokiaMusic::VERSION
+  gem.authors       = ["David Anderson"]
+  gem.email         = ["davidmartinanderson@gmail.com"]
+  gem.description   = "A simple ruby wrapper around the Nokia Music API"
+  gem.summary       = "A gem to get me musical info from Nokia's API"
+  gem.homepage      = "https://github.com/davidmanderson/nokia_music"
+  
+  gem.add_runtime_dependency('rash', '~> 0.3')
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.7')
+  gem.add_runtime_dependency('multi_json', '~> 1.0')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: nokia_music
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A simple ruby wrapper around the Nokia Music API
+email:
+- davidmartinanderson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nokia_music.rb
+- lib/nokia_music/client.rb
+- lib/nokia_music/client/product.rb
+- lib/nokia_music/client/product_sample.rb
+- lib/nokia_music/client/search.rb
+- lib/nokia_music/configuration.rb
+- lib/nokia_music/request.rb
+- lib/nokia_music/version.rb
+- nokia_music.gemspec
+homepage: https://github.com/davidmanderson/nokia_music
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A gem to get me musical info from Nokia's API
+test_files: []
+has_rdoc: