followanalytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b41934781c862369956d4d7a40c713614bf0177
+  data.tar.gz: 16557e7218ad370a1ea10b11cb8da8eb29f9d402
+SHA512:
+  metadata.gz: 52b11d4ba47c19c50eb1951ff0c56ccf3461829c5ba7a0092c6355f1af7398d71841767938be01f2d284c298aa637bd44148970fd5881fee5ef490a80b06587c
+  data.tar.gz: 11c65c49d96f7a0622167845ec3cc794afabb5865f37b6c5db7c18c7f38c53d029907f3d5b11859fafec49da2316fa0ad71c973e55e72ad5963bd25be6a3b5e3

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Specify your gem's dependencies in followanalytics.gemspec
+group :developement do
+  gem 'rubocop'
+  gem 'byebug'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'faker'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    followanalytics (0.1.0)
+      oj (~> 2.17)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    byebug (9.0.5)
+    diff-lcs (1.2.5)
+    domain_name (0.5.20160615)
+      unf (>= 0.0.5, < 1.0.0)
+    faker (1.6.6)
+      i18n (~> 0.5)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    oj (2.17.3)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug
+  faker
+  followanalytics!
+  rake (~> 10.0)
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 José Carlos Joaquim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Followanalytics
+
+Welcome to the FollowAnalytics gem. It will allow to to use the FollowAnalytics Platform API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'followanalytics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install followanalytics
+
+## Usage
+
+### Configuration
+
+```ruby
+# 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
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/followanalytics.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "followanalytics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/followanalytics.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'followanalytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "followanalytics"
+  spec.version       = Followanalytics::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.authors       = ["José Carlos Joaquim"]
+  spec.summary       = %q{Ruby client for the FollowAnalytics API.}
+  spec.description   = %q{Ruby client for the FollowAnalytics API.}
+  spec.homepage      = "https://github.com/followanalytics/fa-api-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'oj', '~> 2.17'
+end

data/lib/followanalytics.rb

@@ -0,0 +1,31 @@
+require "followanalytics/attributes"
+require "followanalytics/version"
+require 'followanalytics/error'
+
+module Followanalytics
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_base_url
+    attr_accessor :attribute_base_url
+
+    DEFAULT_API_BASE_URL = 'https://api.follow-apps.com'
+    DEFAULT_ATTRIBUTES_BASE_URL = 'https://sor.follow-apps.com'
+
+    def initialize
+      @api_base_url = DEFAULT_API_BASE_URL
+      @attribute_base_url = DEFAULT_ATTRIBUTES_BASE_URL
+    end
+  end
+end

data/lib/followanalytics/api.rb

@@ -0,0 +1,7 @@
+module Followanalytics
+  class API
+    class << self
+
+    end
+  end
+end

data/lib/followanalytics/attributes.rb

@@ -0,0 +1,83 @@
+require 'rest-client'
+require 'oj'
+
+module Followanalytics
+  module Attributes
+    class Client
+      attr_accessor :sor_identifier
+
+      MISSING_SOR = 'Missing System of Record identifier.'.freeze
+      MISSING_API_KEY = 'Missing api key in configuration.'.freeze
+
+      PREDEFINED_ATTRIBUTE_KEYS = %w(
+        first_name last_name email date_of_birth gender country city region
+        profile_picture
+      ).freeze
+
+      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|
+        define_method("set_#{attribute_key}") do |value, customer_id|
+          set_value(value, attribute_key, customer_id)
+        end
+      end
+
+      def set_value(value, key, customer_id)
+        hash = attribute_hash(value, key, customer_id)
+        send_attributes(hash)
+      end
+
+      def unset_value(key, customer_id)
+        hash = attribute_hash(nil, key, customer_id)
+        send_attributes(hash)
+      end
+
+      def add_set_value(value, key, customer_id)
+        hash = attribute_hash(value, key, customer_id).tap do |hsh|
+          hsh['action_type'] = 'ADD'
+        end
+        send_attributes(hash)
+      end
+
+      def remove_set_value(value, key, customer_id)
+        hash = attribute_hash(value, key, customer_id).tap do |hsh|
+          hsh['action_type'] = 'REMOVE'
+        end
+        send_attributes(hash)
+      end
+
+      private
+
+      def attributes_url
+        "#{Followanalytics.configuration.attribute_base_url}/api/attribute_values"
+      end
+
+      def attribute_hash(value, key, customer_id)
+        {
+          "attribute_key"    => key,
+          "attribute_value"  => value,
+          "customer_id"      => customer_id,
+          "customer_id_type" => "user_id"
+        }
+      end
+
+      def send_attributes(hash)
+        api_key = Followanalytics.configuration.api_key
+        raise Followanalytics::Error, MISSING_API_KEY if api_key.nil?
+
+        params = Oj.dump({
+          "sor" => @sor_identifier,
+          "api_key" => api_key,
+          "customer_attribute_values" => [hash]
+        })
+
+        response = RestClient.post(attributes_url, params, content_type: :json)
+      rescue RestClient::Exception => exception
+        raise Followanalytics::Error.from_rest_client(exception)
+      end
+    end
+  end
+end

data/lib/followanalytics/error.rb

@@ -0,0 +1,10 @@
+require 'oj'
+
+module Followanalytics
+  class Error < StandardError
+    def self.from_rest_client(exception)
+      body = Oj.load(exception.response.body)
+      self.new(body['message'])
+    end
+  end
+end

data/lib/followanalytics/version.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: followanalytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- José Carlos Joaquim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+description: Ruby client for the FollowAnalytics API.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- followanalytics.gemspec
+- lib/followanalytics.rb
+- lib/followanalytics/api.rb
+- lib/followanalytics/attributes.rb
+- lib/followanalytics/error.rb
+- lib/followanalytics/version.rb
+homepage: https://github.com/followanalytics/fa-api-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for the FollowAnalytics API.
+test_files: []