followanalytics 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b41934781c862369956d4d7a40c713614bf0177
-  data.tar.gz: 16557e7218ad370a1ea10b11cb8da8eb29f9d402
+  metadata.gz: d6353d9c2d7408f04ab06228995da32e9989b3af
+  data.tar.gz: de852e6118309e40391a3e7c395789bdcbda9a13
 SHA512:
-  metadata.gz: 52b11d4ba47c19c50eb1951ff0c56ccf3461829c5ba7a0092c6355f1af7398d71841767938be01f2d284c298aa637bd44148970fd5881fee5ef490a80b06587c
-  data.tar.gz: 11c65c49d96f7a0622167845ec3cc794afabb5865f37b6c5db7c18c7f38c53d029907f3d5b11859fafec49da2316fa0ad71c973e55e72ad5963bd25be6a3b5e3
+  metadata.gz: 2e352cb6efc54eabc4477460928718841b5543d57e53380ba4204b68ceff4b9182c8ac92647de95766b8ccf50ee2f8e300c6c66d4cb43fd2e66190f915e85d22
+  data.tar.gz: f67dc08860b90aed21842519b4fe4bf30c83ad8662d73da2ceaef3e0b70ed57c0b028b6c17bb116d73cc31e7d4b6aabab552181b16a4449bc0d988ec41238a4a

data/README.md

@@ -26,10 +26,41 @@ Or install it yourself as:
 # In an initializer:
 Followanalytics.configure do |config|
   config.api_key = ENV['FA_API_KEY']
-  config.api_base_url = ENV['FA_API_BASE_URL'] # Optional, defaults to "https://api.follow-apps.com".
 end
 ```
 
+### Using the attributes
+
+#### Create a client
+```ruby
+client = Followanalytics::Attributes::Client.new(sor_identifier)
+```
+
+#### Setting a value to a predefined attribute
+```ruby
+client.set_first_name("Tim", "customer-00001")
+```
+
+#### Setting a value to a custom attribute
+```ruby
+client.set_value("apple", "favorite_fruit", "customer-00001")
+```
+
+#### Unsetting an attribute value
+```ruby
+client.unset_value("favorite_fruit", "customer-00001")
+```
+
+#### Adding a value to an attribute of type set
+```ruby
+client.add_set_value("strawberry", "fruit_salad", "customer-00001")
+```
+
+#### Removing a value to an attribute of type set
+```ruby
+client.remove_set_value("strawberry", "fruit_salad", "customer-00001")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/followanalytics.gemspec

@@ -5,6 +5,7 @@ require 'followanalytics/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "followanalytics"
+  spec.email         = "technique@followanalytics.com"
   spec.version       = Followanalytics::VERSION
   spec.required_ruby_version = '>= 2.0.0'
   spec.authors       = ["José Carlos Joaquim"]

data/lib/followanalytics/attributes.rb

@@ -14,27 +14,57 @@ module Followanalytics
         profile_picture
       ).freeze
 
+      # Initializes the Attributes client.
+      #
+      # @param sor_identifier [String] The System of Record we wish to set
+      #   attributes to.
+      # @raise [Followanalytics::Error] When the System of Record is not
+      #   defined.
       def initialize(sor_identifier)
         raise Followanalytics::Error, MISSING_SOR if sor_identifier.nil?
         @sor_identifier = sor_identifier
       end
 
       PREDEFINED_ATTRIBUTE_KEYS.each do |attribute_key|
+        # TODO: Find a way to document these.
         define_method("set_#{attribute_key}") do |value, customer_id|
           set_value(value, attribute_key, customer_id)
         end
       end
 
+      # Set one value for a customer.
+      #
+      # @param value The value to set.
+      # @param key The key of the attribute.
+      # @param customer_id The customer we want to set the attribute to.
+      #
+      # @example Set the value "apple" to the attribute with the key "favorite_fruit" for the customer "tim"
+      #   client.set_value("apple", "favorite_fruit", "tim")
       def set_value(value, key, customer_id)
         hash = attribute_hash(value, key, customer_id)
         send_attributes(hash)
       end
 
+      # Unset one value for a customer.
+      #
+      # @param key The key of the attribute.
+      # @param customer_id The customer we want to unset the attribute to.
+      #
+      # @example Unset the value "apple" to the attribute with the key "favorite_fruit" for the customer "tim"
+      #   client.unset_value("favorite_fruit", "tim")
       def unset_value(key, customer_id)
         hash = attribute_hash(nil, key, customer_id)
         send_attributes(hash)
       end
 
+      # Add a value to an attribute of type set.
+      #
+      # @param value The value to add to the set.
+      # @param key The key of the set attribute.
+      # @param customer_id The customer we want to unset the attribute to.
+      #
+      # @example Add the value "strawberry" to the set attribute with the key "fruit_salad" for the customer "tim"
+      #   client.add_set_value("strawberry", "fruit_salad", "tim")
       def add_set_value(value, key, customer_id)
         hash = attribute_hash(value, key, customer_id).tap do |hsh|
           hsh['action_type'] = 'ADD'
@@ -42,6 +72,14 @@ module Followanalytics
         send_attributes(hash)
       end
 
+      # Remove a value to an attribute of type set.
+      #
+      # @param value The value to add to the set.
+      # @param key The key of the set attribute.
+      # @param customer_id The customer we want to unset the attribute to.
+      #
+      # @example Remove the value "strawberry" to the set attribute with the key "fruit_salad" for the customer "tim"
+      #   client.remove_set_value("strawberry", "fruit_salad", "tim")
       def remove_set_value(value, key, customer_id)
         hash = attribute_hash(value, key, customer_id).tap do |hsh|
           hsh['action_type'] = 'REMOVE'

data/lib/followanalytics/error.rb

@@ -2,9 +2,16 @@ require 'oj'
 
 module Followanalytics
   class Error < StandardError
+    attr_accessor :original_exception
+
+    def initialize(message, original_exception = nil)
+      super(message)
+      @original_exception = original_exception
+    end
+
     def self.from_rest_client(exception)
       body = Oj.load(exception.response.body)
-      self.new(body['message'])
+      self.new(body['message'], exception)
     end
   end
 end

data/lib/followanalytics/version.rb

@@ -1,3 +1,3 @@
 module Followanalytics
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: followanalytics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - José Carlos Joaquim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.17'
 description: Ruby client for the FollowAnalytics API.
-email: 
+email: technique@followanalytics.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the FollowAnalytics API.