attune 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4ef474d66c59fbfb92d08ebdc534457aaebd661
-  data.tar.gz: 2fd75bc17a939aa0fd00f738d253109977867e2c
+  metadata.gz: 5867da9248b0bd888009ad61bf369ed4b66e5485
+  data.tar.gz: 9bfa7c8ca1c9b04babbdf5d81ef0017630f3e180
 SHA512:
-  metadata.gz: 50bbc9485525130501fe6662d724533103547c259d4fce88b2e9734237eb99997fa1d8fb01506a16851c81a58d15d620678fe7269dc818e1db79f7c52bb5b696
-  data.tar.gz: de04269263f15ef7e26d32cb15884c867a7a74641e15bd9af65bb835676ff5667dc8db9ea916c3c7f7df11b1a7f9eb5e6a7dc60687aa23eea68e2c3015e7d9e0
+  metadata.gz: 59a091b696135af426afb2cf86afcabacc994f4d4742942853e260d5ab35d029e705a721fd7922f9d820dd2a3c9a6ea83a0d040e92c645153acb838b7fbafc9b
+  data.tar.gz: 3720f7530e58745cbbf2eb059242019cd54ebcefaa60ec172f102ebd453100af74f24d11fa14c35e638714e98e98cc8579faf6f63338c587b708a4eda8b08f99

data/README.md

@@ -86,6 +86,8 @@ client = Attune::Client.new
 auth_token = client.get_auth_token('my-client-id', 'my-client-secret')
 ```
 
+Also see [Blacklist examples](blacklist.md) for examples of our blacklist API.
+
 ### Configuration
 
 Attune can be configured globally

data/blacklist.md

@@ -0,0 +1,41 @@
+# Blacklist API
+
+## Add a blacklist entry
+
+``` ruby
+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 = '2012-06-04 19:00:00'
+params.active_to = '2012-06-06 19:00:00'
+client.entities.blacklist_save(params)
+```
+
+## Retrieve a blacklist entry
+
+``` ruby
+blacklist = client.entities.blacklist_get(blacklist_id)
+```
+
+## Update a blacklist entry
+
+``` ruby
+params = Attune::Model::BlacklistParams.new
+params.disabled = true
+client.entities.blacklist_update(params)
+```
+
+## Delete a blacklist entry
+
+``` ruby
+client.entities.blacklist_delete(blacklist_id)
+```
+
+## Get all blacklists for your account
+``` ruby
+all_blacklists = client.entities.blacklist_get_all(blacklist_id)
+```

data/lib/attune/models/blacklist.rb

@@ -5,13 +5,13 @@ module Attune
     # @attr [String] id 
     # @attr [String] entity_type 
     # @attr [String] consumer 
-    # @attr [String] end_date 
-    # @attr [Boolean] disabled 
-    # @attr [String] created_at 
     # @attr [String] start_date 
+    # @attr [String] created_date 
+    # @attr [String] updated_date 
+    # @attr [String] end_date 
     # @attr [Array<String>] scope 
     # @attr [Array<String>] ids 
-    # @attr [Boolean] active 
+    # @attr [Boolean] disabled 
     class Blacklist
       attr_accessor :id
       
@@ -22,16 +22,16 @@ module Attune
       attr_accessor :consumer
       
 
-      attr_accessor :end_date
+      attr_accessor :start_date
       
 
-      attr_accessor :disabled
+      attr_accessor :created_date
       
 
-      attr_accessor :created_at
+      attr_accessor :updated_date
       
 
-      attr_accessor :start_date
+      attr_accessor :end_date
       
 
       attr_accessor :scope
@@ -40,7 +40,7 @@ module Attune
       attr_accessor :ids
       
 
-      attr_accessor :active
+      attr_accessor :disabled
       
 
       def initialize(attributes = {})
@@ -52,13 +52,13 @@ module Attune
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @consumer = attributes["consumer"] || attributes[:"consumer"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @end_date = attributes["endDate"] || attributes[:"end_date"]
+        @start_date = attributes["startDate"] || attributes[:"start_date"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @disabled = attributes["disabled"] || attributes[:"disabled"]
+        @created_date = attributes["createdDate"] || attributes[:"created_date"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @created_at = attributes["createdAt"] || attributes[:"created_at"]
+        @updated_date = attributes["updatedDate"] || attributes[:"updated_date"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @start_date = attributes["startDate"] || attributes[:"start_date"]
+        @end_date = attributes["endDate"] || attributes[:"end_date"]
         value = attributes["scope"] || attributes[:"scope"]
         if value.is_a?(Array)
           @scope = value
@@ -70,7 +70,7 @@ module Attune
 
         end
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @active = attributes["active"] || attributes[:"active"]
+        @disabled = attributes["disabled"] || attributes[:"disabled"]
         
 
       end
@@ -92,13 +92,13 @@ module Attune
           :id => :id,
           :entity_type => :entityType,
           :consumer => :consumer,
-          :end_date => :endDate,
-          :disabled => :disabled,
-          :created_at => :createdAt,
           :start_date => :startDate,
+          :created_date => :createdDate,
+          :updated_date => :updatedDate,
+          :end_date => :endDate,
           :scope => :scope,
           :ids => :ids,
-          :active => :active
+          :disabled => :disabled
 
         }
     end

data/lib/attune/models/blacklist_params.rb

@@ -2,20 +2,20 @@ module Attune
   module Model
     # 
     #
+    # @attr [Array<String>] ids 
     # @attr [Boolean] disabled 
     # @attr [String] entity_type 
-    # @attr [Array<String>] ids 
     # @attr [Array<Attune::Model::ScopeEntry>] scope 
     # @attr [String] active_from 
     # @attr [String] active_to 
     class BlacklistParams
-      attr_accessor :disabled
+      attr_accessor :ids
       
 
-      attr_accessor :entity_type
+      attr_accessor :disabled
       
 
-      attr_accessor :ids
+      attr_accessor :entity_type
       
 
       attr_accessor :scope
@@ -29,15 +29,15 @@ module Attune
 
       def initialize(attributes = {})
         return if attributes.empty?
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @disabled = attributes["disabled"] || attributes[:"disabled"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
         value = attributes["ids"] || attributes[:"ids"]
         if value.is_a?(Array)
           @ids = value
 
         end
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @disabled = attributes["disabled"] || attributes[:"disabled"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
         value = attributes["scope"] || attributes[:"scope"]
         if value.is_a?(Array)
           @scope = value.map{ |v| ScopeEntry.new(v) }
@@ -65,9 +65,9 @@ module Attune
       private
       # :internal => :external
       ATTRIBUTE_MAP = {
+          :ids => :ids,
           :disabled => :disabled,
           :entity_type => :entityType,
-          :ids => :ids,
           :scope => :scope,
           :active_from => :activeFrom,
           :active_to => :activeTo

data/lib/attune/models/blacklist_save_response.rb

@@ -2,14 +2,20 @@ module Attune
   module Model
     # 
     #
+    # @attr [String] id 
     # @attr [String] result 
     class BlacklistSaveResponse
+      attr_accessor :id
+      
+
       attr_accessor :result
       
 
       def initialize(attributes = {})
         return if attributes.empty?
         # Workaround since JSON.parse has accessors as strings rather than symbols
+        @id = attributes["id"] || attributes[:"id"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
         @result = attributes["result"] || attributes[:"result"]
         
 
@@ -29,6 +35,7 @@ module Attune
       private
       # :internal => :external
       ATTRIBUTE_MAP = {
+          :id => :id,
           :result => :result
 
         }

data/lib/attune/models/ranking_params.rb

@@ -2,31 +2,31 @@ module Attune
   module Model
     # Inputs for ranking a set of ids for a particular user.
     #
-    # @attr [String] view 
     # @attr [String] user_agent 
     # @attr [String] ip 
-    # @attr [String] customer 
-    # @attr [String] entity_type 
     # @attr [Array<String>] ids 
+    # @attr [String] view 
+    # @attr [String] entity_type 
+    # @attr [String] customer 
     # @attr [Array<Attune::Model::ScopeEntry>] scope 
     # @attr [String] anonymous 
     class RankingParams
-      attr_accessor :view
-      
-
       attr_accessor :user_agent
       
 
       attr_accessor :ip
       
 
-      attr_accessor :customer
+      attr_accessor :ids
+      
+
+      attr_accessor :view
       
 
       attr_accessor :entity_type
       
 
-      attr_accessor :ids
+      attr_accessor :customer
       
 
       attr_accessor :scope
@@ -38,20 +38,20 @@ module Attune
       def initialize(attributes = {})
         return if attributes.empty?
         # Workaround since JSON.parse has accessors as strings rather than symbols
-        @view = attributes["view"] || attributes[:"view"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
         @user_agent = attributes["userAgent"] || attributes[:"user_agent"]
         # Workaround since JSON.parse has accessors as strings rather than symbols
         @ip = attributes["ip"] || attributes[:"ip"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @customer = attributes["customer"] || attributes[:"customer"]
-        # Workaround since JSON.parse has accessors as strings rather than symbols
-        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
         value = attributes["ids"] || attributes[:"ids"]
         if value.is_a?(Array)
           @ids = value
 
         end
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @view = attributes["view"] || attributes[:"view"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @entity_type = attributes["entityType"] || attributes[:"entity_type"]
+        # Workaround since JSON.parse has accessors as strings rather than symbols
+        @customer = attributes["customer"] || attributes[:"customer"]
         value = attributes["scope"] || attributes[:"scope"]
         if value.is_a?(Array)
           @scope = value.map{ |v| ScopeEntry.new(v) }
@@ -77,12 +77,12 @@ module Attune
       private
       # :internal => :external
       ATTRIBUTE_MAP = {
-          :view => :view,
           :user_agent => :userAgent,
           :ip => :ip,
-          :customer => :customer,
-          :entity_type => :entityType,
           :ids => :ids,
+          :view => :view,
+          :entity_type => :entityType,
+          :customer => :customer,
           :scope => :scope,
           :anonymous => :anonymous
 

data/lib/attune/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attune
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - John Hawthorn
@@ -140,6 +140,7 @@ files:
 - README.md
 - Rakefile
 - attune.gemspec
+- blacklist.md
 - lib/attune.rb
 - lib/attune/api/anonymous.rb
 - lib/attune/api/entities.rb