7digital 0.0.7 → 0.1.0

data/lib/sevendigital/model/release.rb

@@ -37,8 +37,8 @@ module Sevendigital
     def price(options={})
       begin
         demand_price(options) if @api_client.configuration.lazy_load
-      rescue
-        puts "Error whilst lazyloading price - #{error.error_code} #{error.error_message}" if @api_client.verbose?
+      rescue Sevendigital::SevendigitalError => error
+        @api_client.log(:verbose) { "Release: Error while lazyloading price - #{error.error_code} #{error.error_message}" }
         raise error if !@api_client.configuration.ignorant_lazy_load
       end
       @price

data/lib/sevendigital/model/sevendigital_object.rb

@@ -25,7 +25,7 @@ class Class # :nodoc:
       begin
         send(demand_method, *options) if instance_variable_get("@#{accessor}").nil? && @api_client.configuration.lazy_load
       rescue Sevendigital::SevendigitalError => error
-        puts "Error whilst lazyloading #{accessor} - #{error.error_code} #{error.error_message}" if @api_client.verbose?
+        @api_client.log(:verbose) { "Class: Error whilse lazyloading #{accessor} - #{error.error_code} #{error.error_message}" }
         raise error if !@api_client.configuration.ignorant_lazy_load
       end
       instance_variable_get("@#{accessor}")

data/lib/sevendigital/model/user.rb

@@ -2,7 +2,11 @@ module Sevendigital
 
   class User < SevendigitalObject
 
-    attr_accessor :oauth_access_token, :id, :type, :email_address
+    attr_accessor :oauth_access_token, :id, :type
+
+    #Artist image URL (optional lazy-loaded property)
+    #@return [String]
+    sevendigital_basic_property :email_address
 
     sevendigital_extended_property :locker
 
@@ -12,6 +16,13 @@ module Sevendigital
       return !@oauth_access_token.nil?
     end
 
+    def get_details(options={})
+      raise Sevendigital::SevendigitalError if !authenticated?
+      user_with_details = @api_client.user.get_details(@oauth_access_token, options)
+      copy_basic_properties_from(user_with_details)
+      user_with_details
+    end
+
     def get_locker(options={})
       raise Sevendigital::SevendigitalError if !authenticated?
       @api_client.user.get_locker(@oauth_access_token, options)

data/lib/sevendigital/pager.rb

@@ -4,11 +4,9 @@ rescue LoadError
 end
 
 module Sevendigital
-
   #@private
   #internal class used to page array results if will_paginate is available
   class Pager # :nodoc:
-
     attr_accessor :page, :page_size, :total_items
 
     def paginate_list(list)
@@ -16,9 +14,7 @@ module Sevendigital
       paged_list = WillPaginate::Collection.create(@page, @page_size, @total_items) do |pager|
         pager.replace(list)
       end
-      return paged_list
+      paged_list
     end
-
   end
-
-end
+end

data/lib/sevendigital/version.rb

@@ -1,5 +1,5 @@
 module Sevendigital
   # The version of the gem
   NAME = "7digital"
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/spec/api_operator_cached_spec.rb

@@ -1,12 +1,12 @@
 require "spec_helper"
 require 'ostruct'
+require 'time'
 
 describe "ApiOperatorCached" do
 
   before do
-    @client = stub(Sevendigital::Client)
-    @client.stub!(:verbose?).and_return(false)
-    @client.stub!(:very_verbose?).and_return(false)
+    conf = test_configuration
+    @client = stub_api_client(conf)
     @cache = stub(Hash)
     @cached_operator = Sevendigital::ApiOperatorCached.new(@client, @cache)
     @stub_api_request = stub_api_request()
@@ -40,7 +40,7 @@ describe "ApiOperatorCached" do
     @cache.stub!(:get).with("key").and_return(http_response)
     @cached_operator.stub!(:response_out_of_date?).with(http_response).and_return(false)
     @cached_operator.should_not_receive(:make_http_request)
-    @cached_operator.should_receive(:digest_http_response).with(http_response)
+    @cached_operator.should_not_receive(:digest_http_response).with(http_response)
     @cached_operator.call_api(@stub_api_request)
   end
 
@@ -74,13 +74,14 @@ describe "ApiOperatorCached" do
 
   it "should cache uncached api response if request was not signed" do
     http_response = stub_http_response()
+    api_response = stub_api_response()
 
     @cached_operator.stub(:create_request_uri).and_return("key")
     @cache.stub!(:get).with("key").and_return(nil)
     @cached_operator.stub!(:make_http_request).and_return(http_response)
-    @cached_operator.stub!(:digest_http_response)
+    @cached_operator.stub!(:digest_http_response).with(http_response).and_return(api_response)
 
-    @cache.should_receive(:set).with("key", http_response).and_return(nil)
+    @cache.should_receive(:set).with("key", api_response).and_return(nil)
     @cached_operator.call_api(@stub_api_request)
   end
 
@@ -90,7 +91,7 @@ describe "ApiOperatorCached" do
     max_age = 12*60*60
 
     http_response = stub_http_response
-    http_response.stub!(:header).and_return({
+    http_response.stub!(:headers).and_return({
       "cache-control" => "private, max-age=#{max_age}",
       "Date" => yesterday.httpdate
     })
@@ -106,7 +107,7 @@ describe "ApiOperatorCached" do
     max_age = 48*60*60
 
     http_response = stub_http_response
-    http_response.stub!(:header).and_return({
+    http_response.stub!(:headers).and_return({
       "cache-control" => "private, max-age=#{max_age}",
       "Date" => yesterday.httpdate
     })
@@ -118,10 +119,10 @@ describe "ApiOperatorCached" do
   it "response should be out of date if it is missing caching headers" do
 
     http_response = stub_http_response
-    http_response.stub!(:header).and_return({})
+    http_response.stub!(:headers).and_return({})
     @cached_operator.response_out_of_date?(http_response, Time.now.utc).should == true
 
-    http_response.stub!(:header).and_return({
+    http_response.stub!(:headers).and_return({
       "Date" => Time.now.utc.httpdate
     })
     @cached_operator.response_out_of_date?(http_response, Time.now.utc).should == true
@@ -131,7 +132,7 @@ describe "ApiOperatorCached" do
   it "response should be out of date if no max-age has been specified" do
 
     http_response = stub_http_response
-    http_response.stub!(:header).and_return({"cache-control" => "no-cache", "Date" => Time.now.utc.httpdate})
+    http_response.stub!(:headers).and_return({"cache-control" => "no-cache", "Date" => Time.now.utc.httpdate})
     @cached_operator.response_out_of_date?(http_response, Time.now.utc).should == true
 
   end
@@ -139,7 +140,7 @@ describe "ApiOperatorCached" do
   it "response should be out of date if it is missing Date header" do
 
     http_response = stub_http_response
-    http_response.stub!(:header).and_return({"cache-control" => "private, max-age=#{2**30}"})
+    http_response.stub!(:headers).and_return({"cache-control" => "private, max-age=#{2**30}"})
     @cached_operator.response_out_of_date?(http_response, Time.now.utc).should == true
     
   end
@@ -150,8 +151,7 @@ describe "ApiOperatorCached" do
   end
   
   def stub_http_response
-    http_response = stub(Net::HTTP)
-    http_response
+    stub(Net::HTTP)
   end
   
   def stub_time(time)

data/spec/api_operator_spec.rb

@@ -6,11 +6,11 @@ describe "ApiOperator" do
 
   before do
     response_digestor = stub(Sevendigital::ApiResponseDigestor)
-    response_digestor.stub!(:from_http_response). and_return(fake_digested_response)
+    response_digestor.stub!(:from_http_response). and_return(fake_api_response)
 
     stub_api_client(test_configuration, response_digestor)
 
-    Net::HTTP.stub!(:get_response).and_return(fake_api_response)
+    Net::HTTP.stub!(:get_response).and_return(fake_http_response)
 
     @api_operator = Sevendigital::ApiOperator.new(@client)
 
@@ -140,7 +140,7 @@ describe "ApiOperator" do
 
   it "should make HTTP request and get http response" do
 
-    http_response = fake_api_response
+    http_response = fake_http_response
 
     @stub_http_request = stub(Net::HTTP::Get)
     @stub_http_client =  stub(Net::HTTP)
@@ -157,8 +157,8 @@ describe "ApiOperator" do
 
   it "should digest the HTTP response and get it out" do
 
-    http_response = fake_api_response
-    digested_response = fake_digested_response
+    http_response = fake_http_response
+    digested_response = fake_api_response
 
     @client.api_response_digestor.should_receive(:from_http_response).with(http_response).and_return(digested_response)
 
@@ -170,8 +170,8 @@ describe "ApiOperator" do
 
     it "should call API by making an http request and digesting the response" do
 
-    http_response = fake_api_response
-    digested_response = fake_digested_response
+    http_response = fake_http_response
+    digested_response = fake_api_response
 
     @api_operator.should_receive(:make_http_request).and_return(http_response)
 
@@ -185,10 +185,10 @@ describe "ApiOperator" do
 
   it "should throw an exception if response is not ok" do
 
-    failed_response = fake_digested_response(false)
+    failed_response = fake_api_response(false)
     failed_response.stub!(:error_code).and_return(4000)
     failed_response.stub!(:error_message).and_return("error")
-    @api_operator.should_receive(:make_http_request).and_return(fake_api_response)
+    @api_operator.should_receive(:make_http_request).and_return(fake_http_response)
     @client.api_response_digestor.stub!(:from_http_response).and_return(failed_response)
     
     running { @api_operator.call_api(@stub_api_request) }.should raise_error(Sevendigital::SevendigitalError) { |error|
@@ -293,35 +293,19 @@ describe "ApiOperator" do
     signed_uri.should =~ /https:\/\/base.api.url\/version\/api\/method/
   end
 
-  def test_configuration
-    configuration = OpenStruct.new
-    configuration.oauth_consumer_key = "oauth_consumer_key"
-    return configuration
+  def fake_http_response(code = 200, body = "response_body")
+    http_stub = stub('Net::HTTPResponse')
+    http_stub.stub!(:code => code, :body => body, :header => {})
+    http_stub
+    #Net::HTTP.new("1.1", code, body).tap {|r| puts r.inspect}
   end
 
-  def fake_api_response(code = 200, body = "response_body")
-    return Net::HTTP.new("1.1", code, body)
+  def fake_api_response(is_ok = true)
+    r = stub(Sevendigital::ApiResponse)
+    r.stub(:ok?).and_return(is_ok)
+    r
   end
 
-  def fake_digested_response(is_ok = true)
-    proxy =  stub(Peachy::Proxy)#.new('<response status="ok"><content>test</content></response>')
-    proxy.stub!(:ok?).and_return(is_ok)
-    proxy
-  end
-
-  def stub_api_client(configuration, response_digestor)
-  @client = stub(Sevendigital::Client)
-  @client.stub!(:configuration).and_return(configuration)
-  @client.stub!(:oauth_consumer).and_return(OAuth::Consumer.new( configuration.oauth_consumer_key, configuration.oauth_consumer_secret))
-  @client.stub!(:api_response_digestor).and_return(response_digestor)
-  @client.stub!(:default_parameters).and_return({:country => 'sk'})
-  @client.stub!(:user_agent_info).and_return("7digital")
-  @client.stub!(:verbose?).and_return(false)
-  @client.stub!(:very_verbose?).and_return(false)
-  @client.stub!(:api_host_and_version).and_return(["base.api.url","version"])
-
-end
-
 def stub_api_request
   api_request = stub(Sevendigital::ApiRequest)
 

data/spec/digestion_tract/api_response_digestor_spec.rb

@@ -7,14 +7,13 @@ describe "ApiResponseDigestor" do
   end
 
   it "should create a response with body from http ok response" do
+    body = '<response status="ok"></response>'
 
-    stub_http_response = stub(Net::HTTPSuccess)
-    stub_http_response.stub!(:is_a?).with(Net::HTTPSuccess).and_return(true)
-    stub_http_response.stub!(:body).and_return('<response status="ok"></response>')
-    stub_http_response.stub!(:header).and_return(nil)
+    stub_http_response = stub_ok_http_response(body)
 
     response =  @api_response_digestor.from_http_response(stub_http_response)
     response.error_code.should == 0
+    response.content.should == body
   end
 
   it "should create an error response from http non-ok response" do
@@ -36,9 +35,7 @@ describe "ApiResponseDigestor" do
 
   it "should store headers from http response" do
 
-    stub_http_response = stub(Net::HTTPSuccess)
-    stub_http_response.stub!(:is_a?).with(Net::HTTPSuccess).and_return(true)
-    stub_http_response.stub!(:body).and_return('<response status="ok"></response>')
+    stub_http_response = stub_ok_http_response('<response status="ok"></response>')
     stub_http_response.stub!(:header).and_return({"cache-control" => "test", "date" => "now"})
 
     response =  @api_response_digestor.from_http_response(stub_http_response)
@@ -48,45 +45,49 @@ describe "ApiResponseDigestor" do
 
 
   it "should create a response with body from xml ok response" do
-
-    xml_response = <<XML
-    <response status="ok"><test>aaa</test></response>
-XML
-    response = @api_response_digestor.from_xml(xml_response)
+    xml_response = stub_ok_http_response("<response status=\"ok\">body</response>")
+    response = @api_response_digestor.from_http_response(xml_response)
     response.error_code.should == 0
-    response.content.test.should_not == nil
-    response.content.nothing.should == nil
   end
 
 
   it "should create a response with error details from xml error response" do
 
-    xml_response = '<response status="error"><error code="1000"><errorMessage>expected error message</errorMessage></error></response>'
-    response = @api_response_digestor.from_xml(xml_response)
+    xml_response = stub_ok_http_response(
+        '<response status="error"><error code="1000"><errorMessage>expected error message</errorMessage></error></response>')
+    response = @api_response_digestor.from_http_response(xml_response)
     response.error_code.should == 1000
     response.error_message.should == 'expected error message'
   end
 
   it "should create a response with error details from invalid xml response" do
 
-    xml_response = '<wrongresponse status="ok"><test /></wrongresponse>'
-    response = @api_response_digestor.from_xml(xml_response)
-    response.error_code.should == 10000
+    xml_response = stub_ok_http_response('<wrongresponse status="ok"><test /></wrongresponse>')
+    response = @api_response_digestor.from_http_response(xml_response)
+    response.error_code.should == 10001
     response.error_message.should == 'Invalid 7digital API response'
 
-    xml_response = '<response><test /></response>'
-    response = @api_response_digestor.from_xml(xml_response)
-    response.error_code.should == 10000
+    xml_response = stub_ok_http_response('<response><test /></response>')
+    response = @api_response_digestor.from_http_response(xml_response)
+    response.error_code.should == 10001
     response.error_message.should == 'Invalid 7digital API response'
   end
 
 
     it "should create a response with error details from valid xml response with invalid status" do
 
-    xml_response = '<response status="unkown"><test></test></response>'
-    response = @api_response_digestor.from_xml(xml_response)
-    response.error_code.should == 10000
+    xml_response = stub_ok_http_response('<response status="unkown"><test></test></response>')
+    response = @api_response_digestor.from_http_response(xml_response)
+    response.error_code.should == 10001
     response.error_message.should == 'Invalid 7digital API response'
+    end
+
+  def stub_ok_http_response(body)
+    stub_http_response = stub(Net::HTTPSuccess)
+    stub_http_response.stub!(:is_a?).with(Net::HTTPSuccess).and_return(true)
+    stub_http_response.stub!(:body).and_return(body)
+    stub_http_response.stub!(:header).and_return(nil)
+    stub_http_response
   end
 
 end

data/spec/digestion_tract/artist_digestor_spec.rb

@@ -14,7 +14,7 @@ describe "ArtistDigestor" do
     </release>
 XML
 
-    running {@artist_digestor.from_xml(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
+    running {@artist_digestor.from_xml_string(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
 
   end
 
@@ -26,29 +26,29 @@ XML
     </artist>
 XML
 
-    artist = @artist_digestor.from_xml(xml_response)
+    artist = @artist_digestor.from_xml_string(xml_response)
     artist.id.should == 123
     artist.name.should == "expected artist name"
   end
 
-   it "should digest artist xml and populate all available properties" do
+  it "should digest artist xml and populate all available properties" do
 
     xml_response = load_sample_object_xml("artist")
-
-    artist = @artist_digestor.from_xml(xml_response)
+    artist = @artist_digestor.from_xml_string(xml_response)
     artist.id.should == 123
     artist.name.should == "The Expected Artist"
     artist.sort_name.should == "Expected Artist, The"
     artist.appears_as.should == "The E.A."
     artist.image.should == "http://somewhere.com/tea.jpg"
     artist.url.should == "http://7digital.com/artists/tea?partner=1"
-   end
+    artist.popularity.should == 0.55
+  end
 
     it "should digest xml containing list of artists and return a paginated array" do
 
     xml_response = load_sample_object_xml("artist_list")
 
-    artists = @artist_digestor.list_from_xml(xml_response, :artists)
+    artists = @artist_digestor.list_from_xml_string(xml_response, :artists)
     artists[0].id.should == 14
     artists[1].id.should == 20
     artists[2].id.should == 106
@@ -61,7 +61,7 @@ XML
 
     xml_response = load_sample_object_xml("artist_list_empty")
 
-    artists = @artist_digestor.list_from_xml(xml_response, :artists)
+    artists = @artist_digestor.list_from_xml_string(xml_response, :artists)
     artists.size.should == 0
     artists.total_entries.should == 0
 
@@ -75,7 +75,7 @@ XML
     </release>
 XML
 
-    running {@artist_digestor.list_from_xml(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
+    running {@artist_digestor.list_from_xml_string(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
 
   end
 

data/spec/digestion_tract/basket_digestor_spec.rb

@@ -16,14 +16,14 @@ describe "BasketDigestor" do
 </zzz>
 XML
 
-    running {@basket_digestor.from_xml(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
+    running {@basket_digestor.from_xml_string(xml_response)}.should raise_error(Sevendigital::DigestiveProblem)
   end
 
   it "should parse from Basket xml and populate all properties" do
 
     xml_response = load_sample_object_xml("basket")
 
-    basket = @basket_digestor.from_xml(xml_response)
+    basket = @basket_digestor.from_xml_string(xml_response)
     basket.id.should == "00000000-0000-0000-0000-000000000000"
     basket.basket_items.size == 1
     basket.basket_items[0].id == 15284882