attune 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5867da9248b0bd888009ad61bf369ed4b66e5485
-  data.tar.gz: 9bfa7c8ca1c9b04babbdf5d81ef0017630f3e180
+  metadata.gz: 3864ecede09a3148c23d49737275d5c49486b6b0
+  data.tar.gz: 42197d4441dec9a6ba768c83323888f9c475429e
 SHA512:
-  metadata.gz: 59a091b696135af426afb2cf86afcabacc994f4d4742942853e260d5ab35d029e705a721fd7922f9d820dd2a3c9a6ea83a0d040e92c645153acb838b7fbafc9b
-  data.tar.gz: 3720f7530e58745cbbf2eb059242019cd54ebcefaa60ec172f102ebd453100af74f24d11fa14c35e638714e98e98cc8579faf6f63338c587b708a4eda8b08f99
+  metadata.gz: ec73bb2719d24b224d44beae11f2bd66a3b78676e57ec311fa0419ac24de71d82ed0868db15e21d9b94b5c746b30a94a87a10b06f103a5e93d79ec16d7e4120a
+  data.tar.gz: 94e15e68ff09a9add6a480ccbc2a2b9e17fc4cedf30f5635a4f5d0cea59560529a6160c034b9934ad63007c0882110f95f3b7ddbfee71141443d32574f6621b5

data/.yardopts

@@ -1,2 +1,4 @@
 --markup-provider=redcarpet
 --markup=markdown
+-
+blacklist.md

data/blacklist.md

@@ -10,9 +10,10 @@ scope = Attune::Model::ScopeEntry.new
 scope.name = 'page'
 scope.value = 'sale'
 params.scope = [scope]
-params.active_from = '2012-06-04 19:00:00'
-params.active_to = '2012-06-06 19:00:00'
-client.entities.blacklist_save(params)
+params.active_from = DateTime.now
+params.active_to = DateTime.now + 7
+response = client.entities.blacklist_save(params)
+blacklist_id = response.id
 ```
 
 ## Retrieve a blacklist entry
@@ -26,7 +27,7 @@ blacklist = client.entities.blacklist_get(blacklist_id)
 ``` ruby
 params = Attune::Model::BlacklistParams.new
 params.disabled = true
-client.entities.blacklist_update(params)
+client.entities.blacklist_update(blacklist_id, params)
 ```
 
 ## Delete a blacklist entry
@@ -36,6 +37,8 @@ client.entities.blacklist_delete(blacklist_id)
 ```
 
 ## Get all blacklists for your account
+
 ``` ruby
-all_blacklists = client.entities.blacklist_get_all(blacklist_id)
+response = client.entities.blacklist_get_all()
+all_blacklists  = response.blacklists
 ```

data/lib/attune/client.rb

@@ -100,10 +100,35 @@ module Attune
 
     def adapter
       raise DisabledException if disabled?
-      Faraday.new(url: endpoint, builder: middleware, request: {timeout: timeout}) do |connection|
+      effective_middleware = middleware || default_middleware
+      Faraday.new(url: endpoint, builder: effective_middleware, request: {timeout: timeout}) do |connection|
         connection.authorization :Bearer, auth_token unless !auth_token
       end
     end
+
+    def default_middleware
+      Faraday::Builder.new do |builder|
+        # Needed for encoding of BATCH GET requests
+        builder.use Attune::ParamFlattener
+
+        builder.use Attune::CallDropping
+
+        builder.request  :url_encoded
+
+        # Allow one retry per request
+        builder.request :retry, 1
+
+        builder.use Attune::JsonLogger, logger if logging_enabled
+
+        # Gzip requests, Faraday handles responses automatically
+        builder.use Attune::Gzip
+
+        # Raise exceptions for HTTP 4xx/5xx
+        builder.response :raise_error
+
+        builder.adapter :attune_http_persistent
+      end
+    end
   end
 end
 

data/lib/attune/configurable.rb

@@ -6,7 +6,9 @@ module Attune
       :middleware,
       :disabled,
       :exception_handler,
-      :timeout
+      :timeout,
+      :logger,
+      :logging_enabled
     ]
 
     # The Authorization token
@@ -25,6 +27,12 @@ module Attune
     # Time (in seconds) to wait for requests to finish
     attr_accessor :timeout
 
+    # Logger to write request statistics to
+    attr_accessor :logger
+
+    # Turn request logging on
+    attr_accessor :logging_enabled
+
     # How to deal with HTTP exceptions
     # @param [:mock, :raise] handler Method used for handling exceptions.
     # @raise [ArgumentError] if handler is not :mock or :raise

data/lib/attune/default.rb

@@ -14,33 +14,8 @@ module Attune
     # user our version of NetHttpPersistent adapter
     Faraday::Adapter.register_middleware(attune_http_persistent: NetHttpPersistent)
 
-    MIDDLEWARE = Faraday::Builder.new do |builder|
-      # Needed for encoding of BATCH GET requests
-      builder.use Attune::ParamFlattener
-
-      # Log all requests
-      builder.use Attune::CallDropping
-
-      builder.request  :url_encoded
-
-      # Allow one retry per request
-      builder.request :retry, 1
-
-      # Log all requests
-      builder.use Attune::JsonLogger
-
-      # Gzip requests, Faraday handles responses automatically
-      builder.use Attune::Gzip
-
-      # Raise exceptions for HTTP 4xx/5xx
-      builder.response :raise_error
-
-      builder.adapter :attune_http_persistent
-    end
-
     configure do |c|
       c.endpoint = ENDPOINT
-      c.middleware = MIDDLEWARE
       c.disabled = false
       c.exception_handler = :raise
       c.timeout = 1

data/lib/attune/version.rb

@@ -1,4 +1,4 @@
 module Attune
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end
 

data/spec/attune/client_spec.rb

@@ -7,7 +7,6 @@ describe Attune::Client do
   context "with defaults" do
     let(:options){ {} }
     specify { expect(subject.endpoint).to eq(Attune::Default::ENDPOINT) }
-    specify { expect(subject.middleware).to eq(Attune::Default::MIDDLEWARE) }
   end
   context "with custom endpoint" do
     let(:endpoint){ 'http://example.com/' }

data/spec/remote_spec.rb

@@ -11,7 +11,7 @@ describe "remote requests" do
     pending "REMOTE_ENDPOINT required for remote spec" unless endpoint
     pending "AUTH_TOKEN required for remote spec" unless auth_token
   end
-  let!(:client){ Attune::Client.new(endpoint: endpoint, auth_token: auth_token) }
+  let!(:client){ Attune::Client.new(endpoint: endpoint, auth_token: auth_token, timeout: 20) }
 
   it "can request an auth_token given a client id and secret" do
     pending "CLIENT_ID required for get_auth_token spec" unless client_id
@@ -66,4 +66,34 @@ describe "remote requests" do
       ranking.sort.should == entities.map(&:to_s).sort
     end
   end
+
+  it 'should call blacklist api' do
+    # create
+    params = Attune::Model::BlacklistParams.new
+    params.ids = [1,2,3]
+    params.entity_type = 'products'
+    scope = Attune::Model::ScopeEntry.new
+    scope.name = 'page'
+    scope.value = 'sale'
+    params.scope = [scope]
+    params.active_from = DateTime.now
+    params.active_to = DateTime.now + 7
+    response = client.entities.blacklist_save(params)
+    blacklist_id = response.id
+    blacklist_id.should match(/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i)
+    # get
+    blacklist = client.entities.blacklist_get(blacklist_id)
+    blacklist.id.should == blacklist_id
+    # update
+    params = Attune::Model::BlacklistParams.new
+    params.disabled = true
+    client.entities.blacklist_update(blacklist_id, params)
+    blacklist = client.entities.blacklist_get(blacklist_id)
+    blacklist.disabled.should == true
+    # get all
+    all_blacklists = client.entities.blacklist_get_all()
+    all_blacklists.blacklists.should be_an Array
+    # delete
+    client.entities.blacklist_delete(blacklist_id)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - John Hawthorn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday