localytics-ruby 0.0.1 → 0.0.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWI0YTMzNDBiYjA1NTUyZDc2Y2ZkMWE3NjJiNGNjN2IxYzJjOGMyZA==
-  data.tar.gz: !binary |-
-    Y2FkMWNjYWU1NGRlOGVmYjVhNDI1NGZiNDJkZDIzOTI1YmY3NWQ1Ng==
+SHA256:
+  metadata.gz: a6b2f7023c1d5e981f2bc4bb4ff10f9970cbc453cfe160102baa554a60a1c945
+  data.tar.gz: 65bbf127d9306b033efef67660e438365c5c1b6b2fda1e78fd3336745e520203
 SHA512:
-  metadata.gz: !binary |-
-    Y2ZlMDU0ZmUxNTI3NzVhMmMyNzBhZGMwNWRiYWQzYjk2ZTgyYzEwNzE2ZDhj
-    MzM3YjZhODNhOTE4NWEzOWFjMDk1ZmQwNmVkYzI5OGIwNWEzNDhmY2FlMDA5
-    NDc4NWIyMWIzYWJkNjgxYTMwNzU4OWYxN2ViNTQ2MWY5MjhmZTE=
-  data.tar.gz: !binary |-
-    ODYzODI2MGZjNDZiZTM3YjY5ZDY2NjJmMjlkNDMwMWQ5MDgwNGY5N2U4NzMw
-    ZTA0ZTY0MGY4OTBlMmY5NTU4ZGFiNWRkNDdjYTVmM2JkZWVjNTFmNjE0MWU3
-    ZTgzZmVlOGJjYWRkNjk2MDMxODA5NWJmODUwYTViMDZjZWRkNzk=
+  metadata.gz: 80bd19ff995e8f0b9379ea6afbc9975ef6987f3a760c3b50858b71acb096dae0e17519fd0bd40ad8d596dea6553961252b830dccd7387eaa82cd8a8a03db8ca6
+  data.tar.gz: 65b7fc28afaa3545b508f7b7e4480a06c67309f0b4fa5c01ebaa69c300ab07d589183f73c63299cee501c62bde21df701f6cc4675dfd69d15ce4b684fa30613d

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tobuy
+
+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,38 @@
+Tobuy
+=====
+
+Ruby wrapper for Localytics API
+
+A lot of inspiration (and code) for how this gem was built come from https://github.com/Mango/mango-ruby
+
+
+## Description
+
+API to interact with Localytics
+https://localytics.com/
+
+
+## Installation
+
+As usual, you can install it using rubygems.
+
+```
+$ gem install localytics-ruby
+```
+
+## Usage
+
+```
+require 'localytics-ruby'
+
+Localytics.api_key = ENV['LOCALYTICS_API_KEY']
+Localytics.api_secret = ENV['LOCALYTICS_API_SECRET']
+
+customerId = 1
+
+begin
+  profile = Localytics::Profile.show 1
+rescue Localytics::Error => e
+  e.each {|code, message| ... }
+end
+```

data/lib/localytics.rb

@@ -3,13 +3,15 @@ require 'json'
 require 'base64'
 require_relative 'localytics/profile'
 require_relative 'localytics/push'
+require_relative 'localytics/app'
+require_relative 'localytics/event'
 
 module Localytics
   class Error < StandardError
     include Enumerable
     attr_accessor :errors
 
-    def initialize message, errors={}
+    def initialize(message, errors={})
       super message
       @errors = errors
     end
@@ -37,30 +39,39 @@ module Localytics
       raise Error.new('No API secret provided')
     end
 
-    payload = JSON.generate(params) if method == :post || method == :patch
-    params = nil unless method == :get
+    unless method == :get
+      payload = JSON.generate(params)
+      params  = nil
+    end
 
     auth = 'Basic ' + Base64.strict_encode64("#{api_key}:#{api_secret}")
 
     headers = {
-        :params => params,
-        :content_type => 'application/json',
-        :accept => 'application/json',
+        :params        => params,
+        :content_type  => 'application/json',
+        :accept        => 'application/json',
         :authorization => auth
 
     }.merge(headers)
 
     options = {
         :headers => headers,
-        :method => method,
-        :url => url,
+        :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)
+      return_hash = {}
+      response    = execute_request(options)
+      return return_hash  if  response.code == 204 && method == :delete
+
+      if response.body && !response.body.empty?
+        # Don't try to call JSON.parse on empty response body.
+        return_hash = JSON.parse(response.body, :symbolize_names => true)
+      end
+      return return_hash
+
     rescue RestClient::Exception => e
       handle_errors e
     end
@@ -72,9 +83,9 @@ module Localytics
     RestClient::Request.execute(options)
   end
 
-  def self.handle_errors exception
-    body = JSON.parse exception.http_body
+  def self.handle_errors(exception)
+    body = JSON.parse(exception.http_body)
     raise Error.new(exception.to_s, body['errors'])
   end
 
-end
+end

data/lib/localytics/app.rb

@@ -0,0 +1,39 @@
+module Localytics
+  class App
+
+    class << self
+      attr_accessor :app_id
+    end
+
+    def self.show_app(app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, url(app_id), api_key, api_secret
+    end
+
+    def self.app_attributes(app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, url(app_id, true), api_key, api_secret
+    end
+
+    def self.show_apps(app_id=nil, api_key=nil, api_secret=nil)
+      Localytics.request api_base, :get, '', api_key, api_secret
+    end
+
+    private
+    def self.api_base
+      "https://api.localytics.com/v1/apps"
+    end
+
+    def self.url(app_id=nil, attributes=nil)
+      unless app_id ||= self.app_id
+        raise Error.new('No APP id provided')
+      end
+
+      url  = "/#{app_id}"
+
+      if attributes
+        url = url + "/attributes"
+      end
+
+      return url
+    end
+  end
+end

data/lib/localytics/event.rb

@@ -0,0 +1,42 @@
+module Localytics
+
+  class Event
+    class << self
+      attr_accessor :app_id
+    end
+
+    # @param event_attributes = Optional hash of up to 50 key/value attribute pairs.
+    #                           Values must be formatted as strings.
+    # @param ltv_change = Optional int representing incremental change in user's lifetime value.
+    #                     Must be integer, e.g. use 299 for $2.99.
+    def self.send(app_id, customer_id, event_name, event_attributes=nil, ltv_change=nil, api_key=nil, api_secret=nil)
+      raise Error.new('No APP id provided') unless app_id ||= self.app_id
+      raise Error.new('No customer_id provided')  if  customer_id.nil?
+      raise Error.new('No event_name provided')   if  event_name.nil? || event_name.empty?
+
+      params = {
+        schema_url:  "https://localytics-files.s3.amazonaws.com/schemas/eventsApi/v1.json",
+        app_uuid:    app_id,
+        customer_id: customer_id.to_s,
+        event_name:  event_name,
+        event_time:  (Time.now.to_f * 1000).to_i,
+        uuid:        SecureRandom.uuid
+      }
+      params[:attributes] = event_attributes if  event_attributes && !event_attributes.empty?
+      params[:ltv_change] = ltv_change       if  ltv_change
+
+      Localytics.request api_base, :post, url, api_key, api_secret, params
+    end
+
+    private
+
+    def self.api_base
+      "https://analytics.localytics.com/events/v1"
+    end
+
+    def self.url
+      "/uploads"
+    end
+  end
+
+end

data/lib/localytics/push.rb

@@ -22,7 +22,7 @@ module Localytics
     #
     # 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={})
+    def self.push(messages, target_type, app_id, campaing_key = nil, api_key=nil, api_secret=nil, headers={})
       Localytics.request(
           api_base(app_id),
           :post,
@@ -32,7 +32,7 @@ module Localytics
           {
               messages: messages,
               target_type: target_type,
-              campaign_key: nil,
+              campaign_key: campaing_key,
               request_id: SecureRandom.uuid
           },
           headers
@@ -40,22 +40,22 @@ module Localytics
     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
+    def self.push_to_customers(messages, app_id, campaing_key = nil, api_key=nil, api_secret=nil)
+      push messages, 'customer_id', app_id, campaing_key, 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
+    def self.push_to_all_customers(messages, app_id, campaing_key = nil, api_key=nil, api_secret=nil)
+      push messages, 'broadcast', app_id, campaing_key, 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
+    def self.push_to_profiles(messages, app_id, campaing_key = nil, api_key=nil, api_secret=nil)
+      push messages, 'profile', app_id, campaing_key, 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
+    def self.push_to_audiences(messages, app_id, campaing_key = nil, api_key=nil, api_secret=nil)
+      push messages, 'audience_id', app_id, campaing_key, api_key, api_secret
     end
 
     private

data/test/localytics_test.rb

@@ -71,3 +71,26 @@ test 'send push' do |mock|
   Localytics::Push.push_to_customers [{alert: 'message', target: 1}], 'app_id'
 end
 
+test 'show apps' do |mock|
+  mock.expects(:get).once.with('https://api.localytics.com/v1/apps', {}).returns(test_response(test_show_apps, 200))
+  apps = Localytics::App.show_apps
+  assert_equal 'App Name', apps[:_embedded][:apps][0][:name]
+end
+
+test 'show app' do |mock|
+  mock.expects(:get).once.with('https://api.localytics.com/v1/apps/umdois', {}).returns(test_response(test_show_app, 200))
+  app = Localytics::App.show_app('umdois')
+  assert_equal 'App Name', app[:name]
+end
+
+test 'show app attributes' do |mock|
+  mock.expects(:get).once.with('https://api.localytics.com/v1/apps/umdois/attributes', {}).returns(test_response(test_apps_attributes, 200))
+  events = Localytics::App.app_attributes('umdois')
+  assert_equal 'Clicked Link', events[:events][0][:event_name]
+end
+
+test 'send event' do |mock|
+  mock.expects(:post).once.with('https://analytics.localytics.com/events/v1/uploads', anything).returns(test_response({}, 202))
+  response = Localytics::Event.send('app_id', 111111, 'event_name')
+  assert(response.empty?)
+end

data/test/test_helper.rb

@@ -83,6 +83,33 @@ def test_profiles(params={})
   }.merge(params)
 end
 
+def test_show_apps(params={})
+  {
+    "_embedded": {
+      "apps": [
+        {
+          "name": "App Name",
+          "app_id": "umdois",
+          "created_at": "2012-04-10T04:07:13Z",
+          "_links": {
+            "self": { "href": "/v1/apps/umdois" },
+            "apps": { "href": "/v1/apps" },
+            "query": {
+              "templated": true,
+              "href": "/v1/apps/umdois/query{?app_id,metrics,dimensions,conditions,limit,order,days,comment,translate}"
+            },
+            "root": { "href": "/v1" }
+          }
+        }
+      ]
+    },
+    "_links": {
+      "self": { "href": "/v1/apps" },
+      "root": { "href": "/v1" }
+    }
+  }
+end
+
 def profile_params
   {
       attributes: {
@@ -93,6 +120,53 @@ def profile_params
   }
 end
 
+
+def test_apps_attributes()
+  {
+    "events": [
+      {
+        "event_name": "Clicked Link",
+        "attributes": [ "link_text", "link_target", "link_placement" ],
+        "high_cardinality_attributes": [ "link_text" ]
+      },
+      {
+        "event_name": "Added to Cart",
+        "attributes": [ "item_name", "item_id" ],
+        "high_cardinality_attributes": [ "item_name", "item_id" ]
+      }
+    ],
+    "_links": {
+      "app": { "href": "/v1/apps/umdois" },
+      "root": { "href": "/v1" }
+    }
+  }
+end
+
+def test_show_app()
+  app_info = test_show_apps.delete(:_embedded)[:apps][0]
+
+  more_info = {
+    "stats": {
+      "sessions": 52291,
+      "closes": 46357,
+      "users": 7008,
+      "events": 865290,
+      "data_points": 963938,
+      "platforms": ["HTML5"],
+      "client_libraries": ["html5_2.6", "html5_2.5", "html5_2.4"],
+      "begin_date": "2013-08-10",
+      "end_date": "2013-09-10"
+    },
+    "icon_url": "https://example.com/app-icon.png",
+    "custom_dimensions": {
+      "custom_0_dimension": "Blood Type",
+      "custom_1_dimension": "Moon Phase"
+    }
+  }
+
+  app_info.merge(more_info)
+end
+
 def bad_request
   json = {
       'errors' => [{
@@ -100,4 +174,4 @@ def bad_request
                    }]
   }
   RestClient::Exception.new(test_response(json, 404), 400)
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Tobuy development team
@@ -9,64 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2020-08-05 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'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !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/
+description: API to interact with Localytics https://localytics.com/
 email:
 - support@tob.uy
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/localytics-ruby.rb
 - lib/localytics.rb
+- lib/localytics/app.rb
+- lib/localytics/event.rb
 - lib/localytics/profile.rb
 - lib/localytics/push.rb
 - test/localytics_test.rb
 - test/test_helper.rb
-homepage: https://tob.uy/
+homepage: https://github.com/tobuy/localytics-ruby
 licenses:
 - MIT
 metadata: {}
@@ -76,20 +80,19 @@ 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
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Localytics API
 test_files:
-- test/localytics_test.rb
 - test/test_helper.rb
+- test/localytics_test.rb