7digital 0.1.2 → 0.1.5

data/spec/api_request_spec.rb

@@ -1,31 +1,46 @@
-require "spec_helper"
-
-describe "ApiRequest" do
-
-  it "should always provide selected parameters in 7digital API format" do
-
-    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {
-            :page => 5,
-            :per_page => 3,
-            :shop_id => 99,
-            :image_size => 999
-    })
-    request.parameters[:page].should == 5
-    request.parameters[:pageSize].should == 3
-    request.parameters[:per_page].should == nil
-    request.parameters[:shopId].should == 99
-    request.parameters[:shop_id].should == nil
-    request.parameters[:imageSize].should == 999
-    request.parameters[:image_size].should == nil
-
-  end
-
-  it "should not contain nil parameters" do
-
-    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {:key1 => "value", :key2 => nil})
-    request.parameters[:key1].should == "value"
-    request.parameters.has_key?(:key2).should == false
-
-  end
-
-end
+require "spec_helper"
+
+describe "ApiRequest" do
+
+  it "should always provide selected parameters in 7digital API format" do
+
+    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {
+            :page => 5,
+            :per_page => 3,
+            :shop_id => 99,
+            :image_size => 999
+    })
+    request.parameters[:page].should == 5
+    request.parameters[:pageSize].should == 3
+    request.parameters[:per_page].should == nil
+    request.parameters[:shopId].should == 99
+    request.parameters[:shop_id].should == nil
+    request.parameters[:imageSize].should == 999
+    request.parameters[:image_size].should == nil
+
+  end
+
+  it "should not contain nil parameters" do
+
+    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {:key1 => "value", :key2 => nil})
+    request.parameters[:key1].should == "value"
+    request.parameters.has_key?(:key2).should == false
+
+  end
+
+  it "parameters should not contain wrapper options" do
+
+    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {:key1 => "value", :cache_max_age => 123})
+    request.parameters[:key1].should == "value"
+    request.parameters.has_key?(:cache_max_age).should == false
+
+  end
+
+  it "options should be populated with wrapper options from parameters" do
+
+    request = Sevendigital::ApiRequest.new(:METHOD, 'method', {:key1 => "value", :cache_max_age => 123})
+    request.options[:cache_max_age].should == 123
+
+  end
+
+end

data/spec/client_configuration_spec.rb

@@ -1,79 +1,79 @@
-require "spec_helper"
-
-describe "ClientConfiguration" do
-
-  it "should initialize with default configuration" do
-    configuration = Sevendigital::ClientConfiguration.new
-    configuration.api_url.should == 'api.7digital.com'
-    configuration.api_version.should == '1.2'
-    configuration.media_api_url.should == 'media-eu.7digital.com'
-    configuration.media_api_version.should == 'media'
-    configuration.account_api_url.should == 'account.7digital.com'
-    configuration.account_api_version.should == 'web'
-  end
-
-  it "should initialize using hash" do
-    configuration = Sevendigital::ClientConfiguration.new(:api_url => "test-hash.7digital.com")
-    configuration.api_url.should == 'test-hash.7digital.com'
-  end
-
-  it "should initialize using OpenStruct object" do
-    configuration = Sevendigital::ClientConfiguration.new(OpenStruct.new(:api_url => "test-openstruct.7digital.com"))
-    configuration.api_url.should == 'test-openstruct.7digital.com'
-  end
-
-  it "should initialize using simple YAML file" do
-    configuration = Sevendigital::ClientConfiguration.new(File.join(File.dirname(__FILE__),"data", "configuration_override.yml"))
-    configuration.api_url.should == 'test-yml-simple.7digital.com'
-  end
-
-  it "should initialize mixing configuration file name and explicit hash override" do
-   conf_file = File.join(File.dirname(__FILE__),"data", "configuration_override.yml")
-   configuration = Sevendigital::ClientConfiguration.new(conf_file, :api_url => 'hash-override')
-   configuration.api_url.should == 'hash-override'
-   configuration.api_version.should == 'yml-simple'
-  end
-
-  it "should initialize mixing hash settings and configuration file override" do
-    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_override.yml")
-    configuration = Sevendigital::ClientConfiguration.new({:api_url => 'hash-override', :xxx => 'yyy'}, conf_file)
-    configuration.api_url.should == 'test-yml-simple.7digital.com'
-    configuration.xxx.should == 'yyy'
-  end
-  
-  it "should initialize mixing 2 explicit hash overrides" do
-    configuration = Sevendigital::ClientConfiguration.new( {:api_url => 'v1', :a => 'x'}, {:api_url => 'v2', :b => 'y'})
-    configuration.api_url.should == 'v2'
-    configuration.a.should == 'x'
-    configuration.b.should == 'y'
-  end
-
-  it "should use environment specific configuration file" do
-    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_env_override.yml")
-    configuration = Sevendigital::ClientConfiguration.new(conf_file)
-    configuration.api_url.should == 'test-yml-common.7digital.com'
-  end
-
-  it "should use environment specific configuration file with environment specific settings" do
-    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_env_override.yml")
-    
-    rails = OpenStruct.new
-    rails.env = "development"
-    Object.const_set(:Rails, rails)
-
-    configuration = Sevendigital::ClientConfiguration.new(conf_file)
-    configuration.api_url.should == 'test-yml-development.7digital.com'
-    Object.instance_eval{ remove_const :Rails }
-  end
-
-  it "should use rails/config/sevendigital configuration as default rails settings" do
-    rails = OpenStruct.new
-    rails.root = Pathname(File.join(File.dirname(__FILE__),"data"))
-    Object.const_set(:Rails, rails)
-
-    configuration = Sevendigital::ClientConfiguration.new()
-    configuration.api_url.should == 'test-yml-rails-common.7digital.com'
-    Object.instance_eval{ remove_const :Rails }
-  end
-
+require "spec_helper"
+
+describe "ClientConfiguration" do
+
+  it "should initialize with default configuration" do
+    configuration = Sevendigital::ClientConfiguration.new
+    configuration.api_url.should == 'api.7digital.com'
+    configuration.api_version.should == '1.2'
+    configuration.media_api_url.should == 'media-eu.7digital.com'
+    configuration.media_api_version.should == 'media'
+    configuration.account_api_url.should == 'account.7digital.com'
+    configuration.account_api_version.should == 'web'
+  end
+
+  it "should initialize using hash" do
+    configuration = Sevendigital::ClientConfiguration.new(:api_url => "test-hash.7digital.com")
+    configuration.api_url.should == 'test-hash.7digital.com'
+  end
+
+  it "should initialize using OpenStruct object" do
+    configuration = Sevendigital::ClientConfiguration.new(OpenStruct.new(:api_url => "test-openstruct.7digital.com"))
+    configuration.api_url.should == 'test-openstruct.7digital.com'
+  end
+
+  it "should initialize using simple YAML file" do
+    configuration = Sevendigital::ClientConfiguration.new(File.join(File.dirname(__FILE__),"data", "configuration_override.yml"))
+    configuration.api_url.should == 'test-yml-simple.7digital.com'
+  end
+
+  it "should initialize mixing configuration file name and explicit hash override" do
+   conf_file = File.join(File.dirname(__FILE__),"data", "configuration_override.yml")
+   configuration = Sevendigital::ClientConfiguration.new(conf_file, :api_url => 'hash-override')
+   configuration.api_url.should == 'hash-override'
+   configuration.api_version.should == 'yml-simple'
+  end
+
+  it "should initialize mixing hash settings and configuration file override" do
+    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_override.yml")
+    configuration = Sevendigital::ClientConfiguration.new({:api_url => 'hash-override', :xxx => 'yyy'}, conf_file)
+    configuration.api_url.should == 'test-yml-simple.7digital.com'
+    configuration.xxx.should == 'yyy'
+  end
+  
+  it "should initialize mixing 2 explicit hash overrides" do
+    configuration = Sevendigital::ClientConfiguration.new( {:api_url => 'v1', :a => 'x'}, {:api_url => 'v2', :b => 'y'})
+    configuration.api_url.should == 'v2'
+    configuration.a.should == 'x'
+    configuration.b.should == 'y'
+  end
+
+  it "should use environment specific configuration file" do
+    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_env_override.yml")
+    configuration = Sevendigital::ClientConfiguration.new(conf_file)
+    configuration.api_url.should == 'test-yml-common.7digital.com'
+  end
+
+  it "should use environment specific configuration file with environment specific settings" do
+    conf_file = File.join(File.dirname(__FILE__),"data", "configuration_env_override.yml")
+    
+    rails = OpenStruct.new
+    rails.env = "development"
+    Object.const_set(:Rails, rails)
+
+    configuration = Sevendigital::ClientConfiguration.new(conf_file)
+    configuration.api_url.should == 'test-yml-development.7digital.com'
+    Object.instance_eval{ remove_const :Rails }
+  end
+
+  it "should use rails/config/sevendigital configuration as default rails settings" do
+    rails = OpenStruct.new
+    rails.root = Pathname(File.join(File.dirname(__FILE__),"data"))
+    Object.const_set(:Rails, rails)
+
+    configuration = Sevendigital::ClientConfiguration.new()
+    configuration.api_url.should == 'test-yml-rails-common.7digital.com'
+    Object.instance_eval{ remove_const :Rails }
+  end
+
 end

data/spec/client_spec.rb

@@ -1,162 +1,162 @@
-require "spec_helper"
-
-describe "Client" do
-
-  it "should not be verbose if not told anything" do
-    client = Sevendigital::Client.new
-    client.verbose?.should == false
-    client.very_verbose?.should == false
-  end
-
-  it "should not be verbose if told to so" do
-    client = Sevendigital::Client.new(:verbose => false)
-    client.verbose?.should == false
-    client.very_verbose?.should == false
-  end
-
-  it "should be verbose if told to be verbose in configuration" do
-    client = Sevendigital::Client.new(:verbose => true)
-    client.verbose?.should == true
-    client.very_verbose?.should == false
-  end
-
-  it "should be very verbose if told to be very verbose in configruation" do
-    client = Sevendigital::Client.new(:verbose => :very_verbose)
-    client.verbose?.should == true
-    client.very_verbose?.should == true
-  end
-
-  it "should be verbose if told so" do
-    client = Sevendigital::Client.new(:verbose => false)
-    client.configuration.verbose = true
-    client.verbose?.should == true
-    client.very_verbose?.should == false
-  end
-
-  it "should provide selected properties as default parameters for all api requests" do
-    client = Sevendigital::Client.new(:page_size => 12345, :country => 'gb')
-    client.configuration.country = 'sk'
-    client.send(:default_parameters).should == {:page_size => 12345, :country => 'sk'}
-  end
-
-  it "create_api_request should merge method parameters and options with parameters taking preference" do
-    client = Sevendigital::Client.new
-    parameters = {:trackId => 1239, :releaseId => 456, :country => "CU"}
-    options = {:page => 1, :country => "US",  :trackId => "SS"}
-    request = client.create_api_request(:GET, 'method', parameters, options)
-    request.parameters[:trackId].should == 1239
-    request.parameters[:releaseId].should == 456
-    request.parameters[:country].should == "CU"
-    request.parameters[:page].should == 1
-    request.parameters.keys.size.should == 4 # page_size == null
-
-  end
-
-  it "create_api_request should add default parameters to request" do
-    client = Sevendigital::Client.new
-    client.configuration.page_size = 100
-    client.configuration.shop_id = 200
-    request = client.create_api_request('method', {}, {})
-
-    request.parameters[:pageSize].should == 100;
-    request.parameters[:shopId].should == 200;
-
-  end
-
-  it "should make an API call using API request created by the client itself " do
-    a_method_name = "method"
-    a_method_params = { :param1 => 1 }
-    an_http_method = :METHOD
-
-    an_api_response = stub(Sevendigital::ApiResponse)
-    an_api_request = stub(Sevendigital::ApiRequest)
-
-    client = Sevendigital::Client.new
-    mock_operator = mock(Sevendigital::ApiOperator)
-    client.stub!(:operator).and_return(mock_operator)
-
-    client.should_receive(:create_api_request).with(an_http_method, a_method_name, a_method_params, {}).and_return(an_api_request)
-
-    mock_operator.should_receive(:call_api).with(an_api_request).and_return(an_api_response)
-
-    response = client.make_api_request(an_http_method, a_method_name, a_method_params, {})
-
-    response.should == an_api_response
-
-  end
-
-  it "should make a signed & secure API call" do
-    a_method_name = "method"
-    a_method_params = { :param1 => 1 }
-    an_http_method = :METHOD
-    a_token = "token"
-
-    an_api_response = "response"
-
-    client = Sevendigital::Client.new
-    mock_operator = mock(Sevendigital::ApiOperator)
-    client.stub!(:operator).and_return(mock_operator)
-
-    mock_operator.should_receive(:call_api) { |api_request|
-       api_request.api_method.should == a_method_name
-       api_request.http_method.should == an_http_method
-       api_request.requires_secure_connection?.should == true
-       api_request.requires_signature?.should == true
-       api_request.parameters.should  == a_method_params
-       api_request.token.should == a_token
-       an_api_response
-    }
-
-    response = client.make_signed_api_request(an_http_method, a_method_name, a_method_params, {}, a_token)
-
-    response.should == an_api_response
-
-  end
-
-  it "should get API host url for specific API service from configuration" do
-
-    client = Sevendigital::Client.new { |configuration|
-      configuration.media_api_url = "media-base.api.url"
-      configuration.media_api_version = "media-version"
-    }
-
-    client.api_host_and_version(:media).should == ["media-base.api.url", "media-version"]
-
-  end
-
-  it "should get API host url for standard API service from configuration" do
-
-    client = Sevendigital::Client.new { |configuration|
-      configuration.api_url = "base.api.url"
-      configuration.api_version = "version"
-    }
-
-    client.send(:api_host_and_version).should == ["base.api.url", "version"]
-
-  end
-
-  it "should provide initialized oauth consumer" do
-
-    configuration =  Sevendigital::ClientConfiguration.new
-    configuration.oauth_consumer_key = "api_key"
-    configuration.oauth_consumer_secret = "secret"
-    configuration.account_api_url = "account.7d.com"
-    configuration.account_api_version = "mobile"
-    client = Sevendigital::Client.new(configuration)
-
-    consumer = client.oauth_consumer
-    consumer.authorize_path.should == "https://account.7d.com/mobile/oauth/authorise"
-    consumer.key.should == "api_key"
-    consumer.secret.should == "secret"
-
-  end
-
-  it "user_agent_info should contain app_name & version if specified" do
-    client = Sevendigital::Client.new(:app_name => "RSpec", :app_version => "0.0.7")
-
-    client.user_agent_info.should == "7digital Gem #{Sevendigital::VERSION}/RSpec 0.0.7"
-
-  end
-
-
+require "spec_helper"
+
+describe "Client" do
+
+  it "should not be verbose if not told anything" do
+    client = Sevendigital::Client.new
+    client.verbose?.should == false
+    client.very_verbose?.should == false
+  end
+
+  it "should not be verbose if told to so" do
+    client = Sevendigital::Client.new(:verbose => false)
+    client.verbose?.should == false
+    client.very_verbose?.should == false
+  end
+
+  it "should be verbose if told to be verbose in configuration" do
+    client = Sevendigital::Client.new(:verbose => true)
+    client.verbose?.should == true
+    client.very_verbose?.should == false
+  end
+
+  it "should be very verbose if told to be very verbose in configruation" do
+    client = Sevendigital::Client.new(:verbose => :very_verbose)
+    client.verbose?.should == true
+    client.very_verbose?.should == true
+  end
+
+  it "should be verbose if told so" do
+    client = Sevendigital::Client.new(:verbose => false)
+    client.configuration.verbose = true
+    client.verbose?.should == true
+    client.very_verbose?.should == false
+  end
+
+  it "should provide selected properties as default parameters for all api requests" do
+    client = Sevendigital::Client.new(:page_size => 12345, :country => 'gb')
+    client.configuration.country = 'sk'
+    client.send(:default_parameters).should == {:page_size => 12345, :country => 'sk'}
+  end
+
+  it "create_api_request should merge method parameters and options with parameters taking preference" do
+    client = Sevendigital::Client.new
+    parameters = {:trackId => 1239, :releaseId => 456, :country => "CU"}
+    options = {:page => 1, :country => "US",  :trackId => "SS"}
+    request = client.create_api_request(:GET, 'method', parameters, options)
+    request.parameters[:trackId].should == 1239
+    request.parameters[:releaseId].should == 456
+    request.parameters[:country].should == "CU"
+    request.parameters[:page].should == 1
+    request.parameters.keys.size.should == 4 # page_size == null
+
+  end
+
+  it "create_api_request should add default parameters to request" do
+    client = Sevendigital::Client.new
+    client.configuration.page_size = 100
+    client.configuration.shop_id = 200
+    request = client.create_api_request('method', {}, {})
+
+    request.parameters[:pageSize].should == 100;
+    request.parameters[:shopId].should == 200;
+
+  end
+
+  it "should make an API call using API request created by the client itself " do
+    a_method_name = "method"
+    a_method_params = { :param1 => 1 }
+    an_http_method = :METHOD
+
+    an_api_response = stub(Sevendigital::ApiResponse)
+    an_api_request = stub(Sevendigital::ApiRequest)
+
+    client = Sevendigital::Client.new
+    mock_operator = mock(Sevendigital::ApiOperator)
+    client.stub!(:operator).and_return(mock_operator)
+
+    client.should_receive(:create_api_request).with(an_http_method, a_method_name, a_method_params, {}).and_return(an_api_request)
+
+    mock_operator.should_receive(:call_api).with(an_api_request).and_return(an_api_response)
+
+    response = client.make_api_request(an_http_method, a_method_name, a_method_params, {})
+
+    response.should == an_api_response
+
+  end
+
+  it "should make a signed & secure API call" do
+    a_method_name = "method"
+    a_method_params = { :param1 => 1 }
+    an_http_method = :METHOD
+    a_token = "token"
+
+    an_api_response = "response"
+
+    client = Sevendigital::Client.new
+    mock_operator = mock(Sevendigital::ApiOperator)
+    client.stub!(:operator).and_return(mock_operator)
+
+    mock_operator.should_receive(:call_api) { |api_request|
+       api_request.api_method.should == a_method_name
+       api_request.http_method.should == an_http_method
+       api_request.requires_secure_connection?.should == true
+       api_request.requires_signature?.should == true
+       api_request.parameters.should  == a_method_params
+       api_request.token.should == a_token
+       an_api_response
+    }
+
+    response = client.make_signed_api_request(an_http_method, a_method_name, a_method_params, {}, a_token)
+
+    response.should == an_api_response
+
+  end
+
+  it "should get API host url for specific API service from configuration" do
+
+    client = Sevendigital::Client.new { |configuration|
+      configuration.media_api_url = "media-base.api.url"
+      configuration.media_api_version = "media-version"
+    }
+
+    client.api_host_and_version(:media).should == ["media-base.api.url", "media-version"]
+
+  end
+
+  it "should get API host url for standard API service from configuration" do
+
+    client = Sevendigital::Client.new { |configuration|
+      configuration.api_url = "base.api.url"
+      configuration.api_version = "version"
+    }
+
+    client.send(:api_host_and_version).should == ["base.api.url", "version"]
+
+  end
+
+  it "should provide initialized oauth consumer" do
+
+    configuration =  Sevendigital::ClientConfiguration.new
+    configuration.oauth_consumer_key = "api_key"
+    configuration.oauth_consumer_secret = "secret"
+    configuration.account_api_url = "account.7d.com"
+    configuration.account_api_version = "mobile"
+    client = Sevendigital::Client.new(configuration)
+
+    consumer = client.oauth_consumer
+    consumer.authorize_path.should == "https://account.7d.com/mobile/oauth/authorise"
+    consumer.key.should == "api_key"
+    consumer.secret.should == "secret"
+
+  end
+
+  it "user_agent_info should contain app_name & version if specified" do
+    client = Sevendigital::Client.new(:app_name => "RSpec", :app_version => "0.0.7")
+
+    client.user_agent_info.should == "7digital Gem #{Sevendigital::VERSION}/RSpec 0.0.7"
+
+  end
+
+
 end