localytics-ruby 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1b8a1d9ae1a451d98a7314093d977114d964193
-  data.tar.gz: 40b171b4e40c8a38356c57fab6bc30006860d48a
+SHA256:
+  metadata.gz: a6b2f7023c1d5e981f2bc4bb4ff10f9970cbc453cfe160102baa554a60a1c945
+  data.tar.gz: 65bbf127d9306b033efef67660e438365c5c1b6b2fda1e78fd3336745e520203
 SHA512:
-  metadata.gz: a10bef510e7104b18ba3b9f4d23749f785c4f641f8058b3ecd213c5609546fbc6f4a1008aeba004c23d9e8c66c33dc1d34d341da19a9c26f2407e82498f65434
-  data.tar.gz: 892283af6236abbfaf97c58dc2ddd4ee8366946d4d1bab87d799164c6ad4069c12f3dfa3e69bcfcdd8e2381257156862426b488d232cb86951eba963e834a5a7
+  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

@@ -4,13 +4,14 @@ 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
@@ -40,30 +41,37 @@ module Localytics
 
     unless method == :get
       payload = JSON.generate(params)
-      params = nil
+      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
@@ -75,8 +83,8 @@ 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
 

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/test/localytics_test.rb

@@ -88,3 +88,9 @@ test 'show app attributes' do |mock|
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Tobuy development team
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -43,14 +43,14 @@ dependencies:
   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 https://localytics.com/
@@ -60,9 +60,12 @@ 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
@@ -86,11 +89,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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