7digital 0.0.1

data/README.rdoc

@@ -0,0 +1,7 @@
+Ruby wrapper for 7digital API 
+
+Example usage:
+	sevendigital_client = Sevendigital::Client.new(:oauth_consumer_key => "YOUR_KEY_HERE", :country => "GB")
+	artist = sevendigital_client.artist.get_details(1)
+	puts artist.name
+

data/lib/peachy_patchy.rb

@@ -0,0 +1,14 @@
+module Peachy
+  class Proxy
+
+  #  hide_public_methods ['kind_of?', 'send']
+
+    def no_matching_xml method_name
+      return nil
+    end
+
+    def ==(other_proxy)
+      (to_s == other_proxy.to_s)
+    end
+  end
+end

data/lib/sevendigital.rb

@@ -0,0 +1,53 @@
+
+module Sevendigital
+
+  # :stopdoc:
+  VERSION = '0.0.1'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb }
+  end
+
+end  # module 7digital
+
+require 'peachy'
+require File.join( File.dirname( File.expand_path(__FILE__)), 'peachy_patchy')
+require File.join( File.dirname( File.expand_path(__FILE__)), 'sevendigital', 'management', 'manager')
+require File.join( File.dirname( File.expand_path(__FILE__)), 'sevendigital', 'digestion_tract', 'digestor')
+require File.join( File.dirname( File.expand_path(__FILE__)), 'sevendigital', 'model', 'sevendigital_object')
+Sevendigital.require_all_libs_relative_to(__FILE__)
+

data/lib/sevendigital/api_operator.rb

@@ -0,0 +1,31 @@
+module Sevendigital
+
+  require 'net/http'
+  
+  class ApiOperator
+
+  def initialize(client)
+    @client = client
+  end
+
+  def call_api(api_request)
+    make_http_request_and_digest(create_request_uri(api_request))
+  end
+
+  def make_http_request_and_digest(uri)
+    http_response = Net::HTTP.get_response(uri)
+    api_response = @client.api_response_digestor.from_http_response(http_response)
+    raise Sevendigital::SevendigitalError, "#{api_response.error_code} - #{api_response.error_message}" if !api_response.ok?
+    api_response
+  end
+
+  def create_request_uri(api_request)
+    api_request.ensure_country_is_set(@client.country)
+    params = api_request.parameters.collect{ |a,v| "&#{a}=#{v}" }.join
+    URI.parse("http://#{@client.configuration.api_url}/#{@client.configuration.api_version}/#{api_request.api_method}"+
+              "?oauth_consumer_key=#{@client.configuration.oauth_consumer_key}#{params}")
+  end
+
+end
+
+end

data/lib/sevendigital/api_operator_cached.rb

@@ -0,0 +1,23 @@
+module Sevendigital
+
+class ApiOperatorCached < ApiOperator
+
+  def initialize(client, cache)
+    @cache = cache
+    super(client)
+  end
+
+  def call_api(api_request)
+    uri = create_request_uri(api_request)
+    api_response = @cache.get(uri.to_s)
+    #puts "got from cache #{uri}" if api_response
+    if (!api_response) then
+      #puts "calling #{uri}"
+      api_response = make_http_request_and_digest(uri)
+      @cache.set(uri.to_s, api_response)
+    end
+    api_response
+  end
+end
+
+end

data/lib/sevendigital/api_request.rb

@@ -0,0 +1,24 @@
+module Sevendigital
+
+class ApiRequest
+
+  attr_reader :api_method, :parameters
+
+  def initialize(api_method, parameters, options = {})
+    @api_method = api_method
+    @parameters = comb_parameters(options.merge(parameters))
+  end
+
+  def comb_parameters(parameters)
+    page_size = parameters[:page_size] || parameters[:per_page]
+    parameters[:pageSize] ||= page_size if page_size
+    return parameters
+  end
+
+  def ensure_country_is_set(country)
+    @parameters[:country] ||= country
+  end
+
+end
+
+end

data/lib/sevendigital/client.rb

@@ -0,0 +1,124 @@
+require 'ostruct'
+require 'yaml'
+
+
+module Sevendigital
+
+  DEFAULT_CONFIGURATION = {
+      :api_url =>  "api.7digital.com",
+      :api_version => "1.2"
+    }
+
+  class Client
+
+  def load_configuration_from_yml(file_name, environment=nil)
+    plain_settings = YAML.load_file(file_name)
+    if (plain_settings["common"] || (environment && plain_settings[environment])) then
+      environment_settings = plain_settings["common"] || {}
+      environment_settings.update(plain_settings[environment]) if environment
+      environment_settings
+    else
+      plain_settings
+    end
+  end
+
+  def load_configurations(configuration)
+    
+    default_settings = Sevendigital::DEFAULT_CONFIGURATION
+
+    if (configuration.kind_of? String) then
+      yml_configuration_file = configuration
+    else
+      yml_configuration_file ="#{RAILS_ROOT}/config/sevendigital.yml" if defined?(RAILS_ROOT)
+      explicit_settings = configuration if configuration.kind_of? Hash
+      explicit_settings = configuration.marshal_dump if configuration.kind_of? OpenStruct
+    end
+
+    environment = defined?(RAILS_ENV) ? RAILS_ENV  : nil
+    yml_settings = load_configuration_from_yml(yml_configuration_file, environment) if yml_configuration_file
+  
+    settings = default_settings
+    settings.update(yml_settings) if yml_settings
+    settings.update(explicit_settings) if explicit_settings
+
+    return OpenStruct.new(settings)
+  end
+
+  #Code here
+
+    def initialize(configuration=nil, api_operator=nil)
+      @configuration = load_configurations(configuration)
+      @api_operator = api_operator || hire_api_operator
+    end
+  
+    def hire_api_operator
+       @configuration.cache ? ApiOperatorCached.new(self, @configuration.cache) : ApiOperator.new(self)
+    end
+
+    def artist
+      @artist_manager ||= ArtistManager.new(self) 
+    end
+
+    def artist_digestor
+      @artist_digestor ||= ArtistDigestor.new(self)
+    end
+    
+    def release
+      @release_manager ||= ReleaseManager.new(self)
+    end
+
+    def release_digestor
+      @release_digestor ||= ReleaseDigestor.new(self)
+    end
+
+    def label_digestor
+      @label_digestor ||= LabelDigestor.new(self)
+    end
+
+    def format_digestor
+      @format_digestor ||= FormatDigestor.new(self)
+    end
+    
+    def price_digestor
+      @price_digestor ||= PriceDigestor.new(self)
+    end
+
+    def pager_digestor
+      @pager_digestor ||= PagerDigestor.new(self)
+    end
+
+    def track
+      @track_manager ||= TrackManager.new(self)
+    end
+
+    def track_digestor
+      @track_digestor ||= TrackDigestor.new(self)
+    end
+
+    def api_response_digestor
+      @api_response_digestor ||= ApiResponseDigestor.new(self)
+    end
+    
+    def chart_item_digestor
+      @chart_item_digestor ||= ChartItemDigestor.new(self)
+    end
+    
+    def configuration
+      return @configuration
+    end
+
+    def operator
+      @api_operator
+    end
+
+    def country
+      @country || @configuration.country
+    end
+
+    def country=(country_code)
+      @country = country_code
+    end
+
+  end
+
+end

data/lib/sevendigital/default_configuration.yml

@@ -0,0 +1,2 @@
+api_url: api.7digital.com
+api_version: 1.2

data/lib/sevendigital/digestion_tract/api_response_digestor.rb

@@ -0,0 +1,52 @@
+module Sevendigital
+
+  class ApiResponseDigestor < Digestor
+
+    def from_xml(xml_or_proxy, element_name = :response)
+      return from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, element_name))
+    end
+
+    def from_proxy(proxy)
+      if proxy && proxy.status then
+        return from_ok_response(proxy)  if proxy.status == 'ok'
+        return from_error_response(proxy.error) if proxy.status == 'error' && proxy.error
+      end
+      return from_invalid_xml
+    end
+
+    def from_invalid_xml
+      response = ApiResponse.new
+      response.error_code = 10000
+      response.error_message = 'Invalid 7digital API response'
+      return response
+    end
+
+    def from_error_response(error)
+      response = ApiResponse.new
+      response.error_code = error.code.to_i
+      response.error_message = error.error_message.value.to_s
+      return response
+    end
+
+    def from_ok_response(response_content)
+      response = ApiResponse.new
+      response.error_code = 0
+      response.content = response_content
+      return response
+    end
+
+    def from_http_response(http_response)
+      return from_xml(http_response.body.to_s) if http_response.is_a?(Net::HTTPSuccess)
+      from_invalid_http_response(http_response)
+    end
+
+    def from_invalid_http_response(http_response)
+      response = ApiResponse.new
+      response.error_code = Integer(http_response.code)
+      response.error_message= http_response.body.to_s
+      return response
+    end
+  
+  end
+
+end

data/lib/sevendigital/digestion_tract/artist_digestor.rb

@@ -0,0 +1,31 @@
+module Sevendigital
+
+  class ArtistDigestor < Digestor
+
+    def default_element_name; :artist end
+    def default_list_element_name; :artists end
+
+    def from_proxy(artist_proxy)
+      make_sure_not_eating_nil(artist_proxy)
+      artist = Artist.new(@api_client)
+      populate_required_properties(artist, artist_proxy)
+      populate_optional_properties(artist, artist_proxy)
+      return artist
+    end
+
+    private
+    
+    def populate_required_properties(artist, artist_proxy)
+      artist.id = artist_proxy.id.to_i
+      artist.name = artist_proxy.name.value.to_s
+    end
+
+    def populate_optional_properties(artist, artist_proxy)
+      artist.sort_name = artist_proxy.sort_name.value.to_s if artist_proxy.sort_name
+      artist.appears_as = artist_proxy.appears_as.value.to_s if artist_proxy.appears_as
+      artist.image = artist_proxy.image.value.to_s if artist_proxy.image
+      artist.url = artist_proxy.url.value.to_s if artist_proxy.url
+    end
+
+  end
+end

data/lib/sevendigital/digestion_tract/chart_item_digestor.rb

@@ -0,0 +1,27 @@
+module Sevendigital
+
+  class ChartItemDigestor < Digestor
+
+    def default_element_name; :chart_item end
+    def default_list_element_name; :chart end
+    
+    def from_proxy(chart_item_proxy)
+      
+      make_sure_not_eating_nil(chart_item_proxy)
+      
+      chart_item = ChartItem.new(@client)
+      chart_item.position = chart_item_proxy.position.value.to_i
+      chart_item.change = chart_item_proxy.change.value.to_s.downcase.to_sym
+      if chart_item_proxy.release then
+        chart_item.item = @api_client.release_digestor.from_proxy(chart_item_proxy.release)
+      elsif chart_item_proxy.track
+        chart_item.item = @api_client.track_digestor.from_proxy(chart_item_proxy.track)
+      else
+        chart_item.item = @api_client.artist_digestor.from_proxy(chart_item_proxy.artist)
+      end
+      return chart_item
+     end
+
+  end
+  
+end

data/lib/sevendigital/digestion_tract/digestor.rb

@@ -0,0 +1,66 @@
+module Sevendigital
+
+  class Digestor
+
+      #TODO TEST THIS CRAP
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def from_xml(xml_or_proxy, element_name = default_element_name)
+        return from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, element_name))
+      end
+
+      def list_from_xml(xml_or_proxy, list_element_name = default_list_element_name)
+        list_from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, list_element_name))
+      end
+
+      def list_from_proxy(object_list_proxy)
+        make_sure_not_eating_nil(object_list_proxy)
+        list = []
+        if object_list_proxy.send(default_element_name) then
+          object_list_proxy.send(default_element_name).each { |object_proxy| list << from_proxy(object_proxy) }
+        end
+        return paginate_results(object_list_proxy, list)
+      end
+
+      #nested parsing for api methods that return standard object inside containers with no additional (useful) information
+      #e.g. tagged_item.artist, recommendation.release, search_result.track, etc
+
+      def nested_list_from_xml(xml_or_proxy, container_element_name, list_element_name = default_list_element_name)
+        nested_list_from_proxy(ProxyPolice.ensure_is_proxy(xml_or_proxy, list_element_name), container_element_name)
+      end
+
+      def nested_list_from_proxy(object_list_proxy, container_element_name)
+        make_sure_not_eating_nil(object_list_proxy)
+        list = []
+        if object_list_proxy.send(container_element_name) then
+          object_list_proxy.send(container_element_name).each do
+            |object_proxy| list << from_proxy(object_proxy.send(default_element_name))
+          end 
+        end
+        return paginate_results(object_list_proxy, list)
+      end
+
+      def paginate_results(xml_results, list)
+        @api_client.pager_digestor.from_xml(xml_results).paginate_list(list)
+      end
+
+      def make_sure_not_eating_nil(proxy)
+        raise DigestiveProblem, "There's nothing i can digest" unless proxy
+      end
+
+      def value_present?(proxy_node)
+        !proxy_node.nil? &&  !proxy_node.value.nil? && !proxy_node.value.empty?
+      end
+
+      def content_present?(proxy_node)
+        !proxy_node.nil?
+      end
+
+  end
+
+  class DigestiveProblem < StandardError;  end
+
+end