insound_api 0.0.2

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'rest-client'
+gem 'nokogiri'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Zachary Kloepping
+
+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,36 @@
+# insound_api
+
+
+[![Build Status](https://secure.travis-ci.org/spilliton/insound_api.png?branch=master)](http://travis-ci.org/spilliton/insound_api)
+[![Code Climate](https://codeclimate.com/github/spilliton/insound_api.png)](https://codeclimate.com/github/spilliton/insound_api)
+
+A ruby gem for accessing the [insound.com Web Service API for affiliates][api_docs].
+
+
+
+## Install
+
+``` ruby
+# Add the following to you Gemfile
+gem 'insound_api'
+
+# Update your bundle
+bundle install
+```
+
+## Usage
+
+You will need to setup insound_api to use your credentials.  If you are using rails, a good place to do this is in a initializer:
+
+``` ruby
+# /config/initializers/insound_api.rb
+
+InsoundApi.setup do |config|
+  config.affiliate_id = 42
+  config.api_password = 'my_password'
+end
+
+```
+
+
+[api_docs]: https://www.insound.com/affiliate/webservices.php

data/Rakefile

@@ -0,0 +1,52 @@
+# 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 = "insound_api"
+  gem.homepage = "http://github.com/spilliton/insound_api"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby gem for accessing the insound.com Web Service API for affiliates}
+  gem.description = %Q{TA ruby gem for accessing the insound.com Web Service API for affiliates}
+  gem.email = "kloeppingzd@gmail.com"
+  gem.authors = ["Zachary Kloepping"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "insound_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/insound_api.gemspec

@@ -0,0 +1,83 @@
+# 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 = "insound_api"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zachary Kloepping"]
+  s.date = "2013-05-06"
+  s.description = "TA ruby gem for accessing the insound.com Web Service API for affiliates"
+  s.email = "kloeppingzd@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "insound_api.gemspec",
+    "lib/insound_api.rb",
+    "lib/insound_api/artist.rb",
+    "lib/insound_api/config.rb",
+    "lib/insound_api/object_base.rb",
+    "lib/insound_api/product.rb",
+    "lib/insound_api/query.rb",
+    "lib/insound_api/request.rb",
+    "lib/insound_api/response.rb",
+    "lib/insound_api/results.rb",
+    "test/config_test.rb",
+    "test/helper.rb",
+    "test/query_test.rb",
+    "test/request_test.rb",
+    "test/response_test.rb",
+    "test/webmock/bad_credentials.xml",
+    "test/webmock/jimmy_eat_world_vinyl.xml",
+    "test/webmock/maxresults.xml",
+    "test/webmock/no_results_found.xml",
+    "test/webmock/zen_arcade.xml"
+  ]
+  s.homepage = "http://github.com/spilliton/insound_api"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A ruby gem for accessing the insound.com Web Service API for affiliates"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/lib/insound_api.rb

@@ -0,0 +1,41 @@
+module InsoundApi
+  autoload :Config, 'insound_api/config'
+  autoload :Request, 'insound_api/request'
+  autoload :Query, 'insound_api/query'
+  autoload :Results, 'insound_api/results'
+  autoload :RequestException, 'insound_api/request'
+  autoload :Response, 'insound_api/response'
+
+  autoload :ObjectBase, 'insound_api/object_base'
+  autoload :Product, 'insound_api/product'
+  autoload :Artist, 'insound_api/artist'
+
+
+  class ConfigException < Exception
+    EXCEPTION_TEXT = <<-eos
+    You must setup InsoundApi before you can use!  Ex:
+
+    InsoundApi.setup do |config|
+      config.affiliate_id = 2343234
+      config.api_password = 'aklsdfjlksdajflks'
+    end
+eos
+  end
+
+  def self.config
+    if @config
+      @config
+    else
+      raise ConfigException, ConfigException::EXCEPTION_TEXT
+    end
+  end
+
+  def self.setup(&block)
+    @config = Config.new
+    yield @config
+  end
+
+  def self.search(params)
+    Query.search(params)
+  end
+end

data/lib/insound_api/artist.rb

@@ -0,0 +1,18 @@
+module InsoundApi
+  class Artist < ObjectBase
+
+    def name
+      @name ||= parse_str('artist_name')
+    end
+
+    def format
+      @format ||= parse_str('format')
+    end
+
+    def id
+      @id ||= parse_int('artist_id')
+    end
+
+
+  end
+end

data/lib/insound_api/config.rb

@@ -0,0 +1,5 @@
+module InsoundApi
+  class Config
+    attr_accessor :affiliate_id, :api_password
+  end
+end

data/lib/insound_api/object_base.rb

@@ -0,0 +1,27 @@
+module InsoundApi
+  class ObjectBase
+
+    def initialize(node)
+      @node = node
+    end
+
+    def url
+      @url ||= parse_str('url')
+    end
+
+    def title
+      @title ||= parse_str('title')
+    end
+
+    private
+
+    def parse_str(selector)
+      Results.parse_str(selector, @node)
+    end
+
+    def parse_int(selector)
+      Results.parse_int(selector, @node)
+    end
+
+  end
+end

data/lib/insound_api/product.rb

@@ -0,0 +1,17 @@
+module InsoundApi
+  class Product < ObjectBase
+
+    def artist_name
+      @artist_name ||= parse_str('artist_name')
+    end
+
+    def format
+      @format ||= parse_str('format')
+    end
+
+    def id
+      @id ||= parse_str('product_id')
+    end
+
+  end
+end

data/lib/insound_api/query.rb

@@ -0,0 +1,17 @@
+module InsoundApi
+  class Query
+
+    def self.search(params)
+      response = Request.get(params)
+      response.results
+    end
+
+    # not yet supported
+    # def self.product_search(params={})
+    #   params[:requesttype] = 'product'
+    #   response = Request.get(params)
+    #   response.results
+    # end
+
+  end
+end

data/lib/insound_api/request.rb

@@ -0,0 +1,76 @@
+require 'rest_client'
+
+module InsoundApi
+
+  class RequestException < Exception; end
+
+  class Request
+
+    BASE_URL = "https://www.insound.com/ws/affiliate/"
+    VALID_FORMATS = %w{all vinyl seveninch digital poster shirt cd}
+
+    attr_reader :params
+
+    def initialize(opts={})
+      unless opts[:artist]
+        raise RequestException, ":artist is a required param for any request"
+      end
+
+      if opts[:format] && !VALID_FORMATS.include?(opts[:format].downcase)
+        raise RequestException, ":format must be one of the follwing: #{VALID_FORMATS.join(', ')}"
+      end
+
+      @params = opts
+    end
+
+    def self.get(opts={})
+      request = Request.new(opts)
+      request.get_response
+    end
+
+    def get_response
+      data = RestClient.get(build_url)
+      response = data ? build_response(data) : nil
+
+      if response.errors?
+        raise RequestException, "The following errors were returned: #{response.errors.inspect}"
+      else
+        response
+      end
+    end
+
+    def build_response(data)
+      Response.new(:raw_xml => data.to_str, :request => self)
+    end
+
+    def build_params
+      {param_name => params}
+    end
+
+    def build_url
+      url = base_url_with_creds
+      if params.any?
+        parts = []
+        params.each_pair do |name, value|
+          parts << "#{URI.escape(name.to_s)}=#{URI.escape(value.to_s)}"
+        end
+        url = "#{url}&#{parts.join('&')}"
+      end
+      url
+    end
+
+
+    def affiliate_id
+      InsoundApi.config.affiliate_id
+    end
+
+    def api_password
+      InsoundApi.config.api_password
+    end
+
+    def base_url_with_creds
+      "#{BASE_URL}?id=#{affiliate_id}&password=#{api_password}"
+    end
+
+  end
+end

data/lib/insound_api/response.rb

@@ -0,0 +1,70 @@
+require 'nokogiri'
+require 'rest-client'
+
+module InsoundApi
+  class Response
+
+    attr_reader :request, :raw_xml, :doc, :results
+
+    def initialize(opts={})
+      @request = opts[:request]
+      @raw_xml = opts[:raw_xml]
+      @doc = Nokogiri::XML(@raw_xml)
+      @results = Results.new(@doc)
+    end
+
+    def errors?
+      errors.any?
+    end
+
+    def errors
+      unless @errors
+        @errors = doc.css('errors request_error').map{ |node|
+          code = node.css('error_code').first.inner_html
+          text = node.css('error_text').first.inner_html
+          {:code => code, :text => text}
+        }
+      end
+      @errors
+    end
+
+    # # used by non-array returning responses
+    # def to_struct
+    #   struct = struct_from_hash(json)
+    #   struct.new(*deserialize_values(json))
+    # end
+
+    # # used by array returning resonses
+    # def to_a
+    #   struct = nil
+    #   self.json.map{|obj|
+    #     struct ||= struct_from_hash(obj)
+    #     struct.new(*deserialize_values(obj))
+    #   }
+    # end
+
+    private
+
+    # def struct_from_hash(hash)
+    #   attributes = hash.keys.map{|k|k.to_sym}
+    #   Struct.new(*attributes)
+    # end
+
+    # def deserialize_values(hash)
+    #   hash.values.map{|v| from_json(v) }
+    # end
+
+    # def from_xml(obj)
+    #   if is_date?(obj)
+    #     DateTime.strptime(obj, '%Y-%m-%dT%H:%M:%SZ')
+    #   else
+    #     obj
+    #   end
+    # end
+
+    # def is_date?(obj)
+    #   obj.is_a?(String) && obj =~ /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/i
+    # end
+
+  end
+end