localytics-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWI0YTMzNDBiYjA1NTUyZDc2Y2ZkMWE3NjJiNGNjN2IxYzJjOGMyZA==
+  data.tar.gz: !binary |-
+    Y2FkMWNjYWU1NGRlOGVmYjVhNDI1NGZiNDJkZDIzOTI1YmY3NWQ1Ng==
+SHA512:
+  metadata.gz: !binary |-
+    Y2ZlMDU0ZmUxNTI3NzVhMmMyNzBhZGMwNWRiYWQzYjk2ZTgyYzEwNzE2ZDhj
+    MzM3YjZhODNhOTE4NWEzOWFjMDk1ZmQwNmVkYzI5OGIwNWEzNDhmY2FlMDA5
+    NDc4NWIyMWIzYWJkNjgxYTMwNzU4OWYxN2ViNTQ2MWY5MjhmZTE=
+  data.tar.gz: !binary |-
+    ODYzODI2MGZjNDZiZTM3YjY5ZDY2NjJmMjlkNDMwMWQ5MDgwNGY5N2U4NzMw
+    ZTA0ZTY0MGY4OTBlMmY5NTU4ZGFiNWRkNDdjYTVmM2JkZWVjNTFmNjE0MWU3
+    ZTgzZmVlOGJjYWRkNjk2MDMxODA5NWJmODUwYTViMDZjZWRkNzk=

data/lib/localytics-ruby.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/localytics'

data/lib/localytics.rb

@@ -0,0 +1,80 @@
+require 'rest_client'
+require 'json'
+require 'base64'
+require_relative 'localytics/profile'
+require_relative 'localytics/push'
+
+module Localytics
+  class Error < StandardError
+    include Enumerable
+    attr_accessor :errors
+
+    def initialize message, errors={}
+      super message
+      @errors = errors
+    end
+
+    # Yield [error_code, message] pairs
+    def each
+      @errors.each { |e| yield *e.first }
+    end
+  end
+
+  class << self
+    attr_accessor :api_key, :api_secret
+  end
+
+  def self.request(api_base, method, url, api_key=nil, api_secret=nil, params={}, headers={})
+    method = method.to_sym
+
+    url = api_base + url
+
+    unless api_key ||= @api_key
+      raise Error.new('No API key provided')
+    end
+
+    unless api_secret ||= @api_secret
+      raise Error.new('No API secret provided')
+    end
+
+    payload = JSON.generate(params) if method == :post || method == :patch
+    params = nil unless method == :get
+
+    auth = 'Basic ' + Base64.strict_encode64("#{api_key}:#{api_secret}")
+
+    headers = {
+        :params => params,
+        :content_type => 'application/json',
+        :accept => 'application/json',
+        :authorization => auth
+
+    }.merge(headers)
+
+    options = {
+        :headers => headers,
+        :method => method,
+        :url => url,
+        :payload => payload
+    }
+
+    begin
+      response = execute_request(options)
+      return {} if response.code == 204 and method == :delete
+      JSON.parse(response.body, :symbolize_names => true)
+    rescue RestClient::Exception => e
+      handle_errors e
+    end
+  end
+
+  private
+
+  def self.execute_request(options)
+    RestClient::Request.execute(options)
+  end
+
+  def self.handle_errors exception
+    body = JSON.parse exception.http_body
+    raise Error.new(exception.to_s, body['errors'])
+  end
+
+end

data/lib/localytics/profile.rb

@@ -0,0 +1,45 @@
+module Localytics
+  class Profile
+    class << self
+      attr_accessor :app_id
+    end
+
+    def self.create(customer_id, params={}, app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :post, url(customer_id, app_id), api_key, api_secret, params
+    end
+
+    def self.update(customer_id, params={}, app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :patch, url(customer_id, app_id), api_key, api_secret, params
+    end
+
+    def self.show(customer_id, app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, url(customer_id, app_id), api_key, api_secret
+    end
+
+    def self.delete(customer_id, app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :delete, url(customer_id, app_id), api_key, api_secret
+    end
+
+    def self.profiles(customer_id, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, "/customers/#{customer_id}", api_key, api_secret
+    end
+
+    def self.profiles_by_email(customer_email, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, "/customers?email=#{customer_email}", api_key, api_secret
+    end
+
+    private
+
+    def self.api_base
+      'https://profile.localytics.com/v1'
+    end
+
+    def self.url(id=nil, app_id=nil)
+      if app_id ||= self.app_id
+        return "/apps/#{app_id}/profiles/#{id}"
+      end
+
+      id ? "/profiles/#{id}" : ''
+    end
+  end
+end

data/lib/localytics/push.rb

@@ -0,0 +1,71 @@
+require 'securerandom'
+
+module Localytics
+  class Push
+
+    class << self
+      attr_accessor :app_id
+    end
+
+    # Generic method to send push notifications thru Localytics.
+    # Mandatory parameters:
+    # * :messages an array containing the push messages to send.
+    # * :target_type targeted resource. Available values are:
+    #     :customer_id
+    #     :broadcast
+    #     :profile
+    #     :audience_id
+    # Optional attributes are:
+    # * :api_key
+    # * :api_secret
+    # * :headers
+    #
+    # More information on how messages can be built can be found on
+    # http://docs.localytics.com/#Dev/getting-started-trans-push.html
+    def self.push(messages, target_type, app_id=nil, api_key=nil, api_secret=nil, headers={})
+      Localytics.request(
+          api_base(app_id),
+          :post,
+          '',
+          api_key,
+          api_secret,
+          {
+              messages: messages,
+              target_type: target_type,
+              campaign_key: nil,
+              request_id: SecureRandom.uuid
+          },
+          headers
+      )
+    end
+
+    # For :messages options please check the :push method
+    def self.push_to_customers(messages, app_id, api_key=nil, api_secret=nil)
+      push messages, 'customer_id', app_id, api_key, api_secret
+    end
+
+    # For :messages options please check the :push method
+    def self.push_to_all_customers(messages, app_id, api_key=nil, api_secret=nil)
+      push messages, 'broadcast', app_id, api_key, api_secret
+    end
+
+    # For :messages options please check the :push method
+    def self.push_to_profiles(messages, app_id, api_key=nil, api_secret=nil)
+      push messages, 'profile', app_id, api_key, api_secret
+    end
+
+    def self.push_to_audiences(messages, app_id, api_key=nil, api_secret=nil)
+      push messages, 'audience_id', app_id, api_key, api_secret
+    end
+
+    private
+
+    def self.api_base app_id
+      unless app_id ||= self.app_id
+        raise Error.new('No APP id provided')
+      end
+
+      "https://messaging.localytics.com/v2/push/#{app_id}"
+    end
+  end
+end

data/test/localytics_test.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../lib/localytics', File.dirname(__FILE__))
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+require 'cutest'
+require 'mocha/api'
+include Mocha::API
+
+prepare do
+  Localytics.api_key = '1234'
+  Localytics.api_secret = '1234'
+end
+
+setup do
+  Localytics.mock_rest_client = mock
+end
+
+test 'operation show' do |mock|
+  mock.expects(:get).once.with('https://profile.localytics.com/v1/profiles/123', {}).returns(test_response(test_profile))
+  profile = Localytics::Profile.show 123
+  assert_equal 'Tester', profile[:attributes]['$first_name'.to_sym]
+end
+
+test 'operation show in app' do |mock|
+  mock.expects(:get).once.with('https://profile.localytics.com/v1/apps/app_id/profiles/123', {}).returns(test_response(test_profile))
+  profile = Localytics::Profile.show 123, 'app_id'
+  assert_equal 'Tester', profile[:attributes]['$first_name'.to_sym]
+end
+
+test 'operation show in app global' do |mock|
+  mock.expects(:get).once.with('https://profile.localytics.com/v1/apps/app_id/profiles/123', {}).returns(test_response(test_profile))
+  Localytics::Profile.app_id = 'app_id'
+  profile = Localytics::Profile.show 123
+  assert_equal 'Tester', profile[:attributes]['$first_name'.to_sym]
+  Localytics::Profile.app_id = nil
+end
+
+test 'operation create' do |mock|
+  mock.expects(:post).once.with('https://profile.localytics.com/v1/profiles/1234', anything).returns(test_response(test_profile))
+  profile = Localytics::Profile.create 1234, profile_params
+  assert_equal 'Tester', profile[:attributes]['$first_name'.to_sym]
+end
+
+test 'operation update' do |mock|
+  mock.expects(:patch).once.with('https://profile.localytics.com/v1/profiles/1234', anything).returns(test_response(test_profile))
+  profile = Localytics::Profile.update 1234, profile_params
+  assert_equal 'Tester', profile[:attributes]['$first_name'.to_sym]
+end
+
+test 'operation delete' do |mock|
+  mock.expects(:delete).once.with('https://profile.localytics.com/v1/profiles/1234').returns(test_response({}, 204))
+  profile = Localytics::Profile.delete 1234
+  assert(profile.empty?)
+end
+
+test 'operation profiles' do |mock|
+  mock.expects(:get).once.with('https://profile.localytics.com/v1/customers/Isa', {}).returns(test_response(test_profiles))
+  profiles = Localytics::Profile.profiles 'Isa'
+  assert_equal 'Isa', profiles[:id]
+  assert_equal 'Isa', profiles[:profiles][0][:attributes][:name]
+end
+
+test 'operation profiles' do |mock|
+  mock.expects(:get).once.with('https://profile.localytics.com/v1/customers?email=isa@localytics.com', {}).returns(test_response(test_profiles))
+  profiles = Localytics::Profile.profiles_by_email 'isa@localytics.com'
+  assert_equal 'Isa', profiles[:id]
+  assert_equal 'Isa', profiles[:profiles][0][:attributes][:name]
+end
+
+test 'send push' do |mock|
+  mock.expects(:post).once.with('https://messaging.localytics.com/v2/push/app_id', anything).returns(test_response({}, 200))
+  Localytics::Push.push_to_customers [{alert: 'message', target: 1}], 'app_id'
+end
+

data/test/test_helper.rb

@@ -0,0 +1,103 @@
+module Localytics
+  @mock_rest_client = nil
+
+  def self.mock_rest_client=(mock_client)
+    @mock_rest_client = mock_client
+  end
+
+  def self.execute_request(options)
+    case options[:method]
+      when :get
+        @mock_rest_client.get options[:url], options[:headers][:params]
+      when :post
+        @mock_rest_client.post options[:url], options[:payload]
+      when :patch
+        @mock_rest_client.patch options[:url], options[:payload]
+      when :delete
+        @mock_rest_client.delete options[:url]
+    end
+  end
+end
+
+Response = Struct.new :body, :code
+
+def test_response body, code=200
+  Response.new JSON.generate(body), code
+end
+
+def test_profile(params={})
+  {
+      attributes: {
+          '$first_name' => 'Tester',
+          '$last_name' => 'Localytics',
+          '$email' => 'tester@localytics.com'
+      },
+      localytics: {
+          attributes: {
+              last_session_date: '2015-08-21',
+              device_timezone: '-03:00',
+              country: 'ar',
+              language: 'es',
+              user_type: 'known'
+          }
+      }
+  }.merge(params)
+end
+
+def test_profiles(params={})
+  {
+      'id': 'Isa',
+      'profiles': [
+          {
+              'attributes': {
+                  'name': 'Isa',
+                  'cats': ['Ofelia', 'Mittens', 'Spot', 'Schrödinger'],
+                  'age': 30,
+                  'lucky numbers': [1, 48, -100, 13],
+                  'birthday': '1983-01-01'
+              },
+              'localytics': {
+                  'attributes': {
+                      'country': 'us',
+                      'city_name': 'Boston',
+                      'last_session_date': '2015-01-15'
+                  }
+              }
+          },
+          {
+              'app_id': 'my_app',
+              'attributes': {
+                  'high score': 30,
+                  'favorite teams': ['Red Sox', 'Yankees']
+              },
+              'localytics': {
+                  'attributes': {
+                      'app_version': '3.1',
+                      'push_enabled': 1,
+                      'custom_1': 'yes'
+                  }
+              }
+          }
+      ]
+
+  }.merge(params)
+end
+
+def profile_params
+  {
+      attributes: {
+          '$email' => 'test@localytics.com',
+          '$first_name' => 'Tester Sister',
+          '$last_name' => 'Localytics'
+      }
+  }
+end
+
+def bad_request
+  json = {
+      'errors' => [{
+                       '4051' => 'Bad Request: The request could not be understood by the server due to malformed syntax.'
+                   }]
+  }
+  RestClient::Exception.new(test_response(json, 404), 400)
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: localytics-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobuy development team
+- Marcos Chicote
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: API to interact with Localytics\nhttps://localytics.com/
+email:
+- support@tob.uy
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/localytics-ruby.rb
+- lib/localytics.rb
+- lib/localytics/profile.rb
+- lib/localytics/push.rb
+- test/localytics_test.rb
+- test/test_helper.rb
+homepage: https://tob.uy/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Localytics API
+test_files:
+- test/localytics_test.rb
+- test/test_helper.rb