tracksale 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76d53474a5c3b1fa9024934278723ff0c662f7ed
-  data.tar.gz: b6f11b4978a21bde64d3be153d23756761a398a0
+  metadata.gz: af7f8274dff3ad33e55832a593f15e4965e99419
+  data.tar.gz: c2d60b9ee85c3ceea683c2eef7dcf67a3234173e
 SHA512:
-  metadata.gz: 10747530be997594f6037c8ca6052fa27dd5d96adfe3c3c76e193d50effdea0200ca5201a1283e08f3827adf2cc98931835cdda320b891be1a2f6667dc0a33ad
-  data.tar.gz: 966369ca3f566efd8dd7e8db0a85fd997f411614822c7805aff934dddc378255c66b57550131ffa002611177e589b1ff7bd08cb2b3b5680b47b9509bc6fcb22c
+  metadata.gz: 392b16321685edc724ec7554d4d44fbd34f7c8762ed3e67a11602ff5e887523d0d484abb9767252987cdbf195c4eb726dc5cf39f20fc7527e635c5abee48178f
+  data.tar.gz: bcf6f73d574e113f7b1f8f16059c74a35309b2cf8d65c616d368d789987048e91c916af326d506aacfa66e1dfe5a658d8ad025439ecb9117be24a0b1734bf746

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/tracksale.svg)](https://badge.fury.io/rb/tracksale)
 # Tracksale
 Tracksale v2 API integration gem.
 
@@ -17,7 +18,37 @@ Tracksale.configure do |config|
 end
 ```
 
+If you want to run the dummy client, which prevents the gem from accessing the API (useful for developers without tracksale credential access) you can:
+
+```
+Tracksale.configure do |config|
+  config.force_dummy_client
+end
+```
+
+Also the dummy client accepts a default response that you can set and may be useful for some testings as in:
+
+``` 
+> Tracksale::DummyClient.response = nil # default value
+=> nil
+> Tracksale::Campaign.all
+=> []
+
+> Tracksale::DummyClient.response = [{
+  'name' => 'foo', 
+  'code' => 'bar', 
+  'detractors' => '0' , 
+  'passives' => 1, 
+  'promoters' => 2
+}]
+=> [{"name"=>"foo", "code"=>"bar", "detractors"=>"0", "passives"=>1, "promoters"=>2}]
+> Tracksale::Campaign.all
+=> [#<Tracksale::Campaign:0x0055ea11d2b738 @code="bar", @name="foo", @score={:detractors=>"0", :passives=>1, :promoters=>2}>]
+
+```
+
 Key generation instructions can be found on the official documentation at: https://api.tracksale.co/?lang=en#submenu1
+
 ## Using
 
 After configuration you should be able to use it easily as in

data/lib/tracksale/answer.rb

@@ -0,0 +1,71 @@
+module Tracksale
+  class Answer
+    LIMIT = -1
+
+    attr_accessor :time, :type, :name,
+                  :email, :identification, :phone,
+                  :nps_answer, :last_nps_answer, :nps_comment,
+                  :campaign_name, :campaign_code, :id,
+                  :deadline, :elapsed_time, :dispatch_time,
+                  :reminder_time, :status, :tags,
+                  :categories, :justifications
+
+    def campaign
+      Tracksale::Campaign.find_by_code(campaign_code)
+    end
+
+    class << self
+      def all
+        raw_all.map { |answer| create_from_response(answer) }
+      end
+
+      def create_from_response(raw_response)
+        new.tap do |answer|
+          answer.time = Time.at(raw_response['time'].to_i)
+          answer.type = raw_response['type']
+          answer.name = raw_response['name']
+          answer.email = raw_response['email']
+          answer.identification = raw_response['identification']
+          answer.phone = raw_response['phone']
+          answer.nps_answer = raw_response['nps_answer']
+          answer.last_nps_answer = raw_response['last_nps_answer']
+          answer.nps_comment = raw_response['nps_comment']
+          answer.campaign_name = raw_response['campaign_name']
+          answer.campaign_code = raw_response['campaign_code']
+          answer.id = raw_response['id']
+          answer.deadline = raw_response['deadline']
+          answer.elapsed_time = raw_response['elapsed_time']
+          answer.dispatch_time = raw_response['dispatch_time']
+          answer.reminder_time = raw_response['reminder_time']
+          answer.status = raw_response['status']
+          answer.tags = convert_tags(raw_response['tags'])
+          answer.categories = raw_response['categories'].map { |c| c['name'] }
+          answer.justifications = convert_justif(raw_response['justifications'])
+        end
+      end
+
+      def raw_all
+        client.get('report/answer?tags=true&limit=' + LIMIT.to_s)
+      end
+
+      def client
+        Tracksale.configuration.client.new
+      end
+
+      def convert_tags(tags)
+        tags.map do |tag|
+          { tag['name'] => tag['value'] }
+        end.reduce(&:merge)
+      end
+
+      def convert_justif(multiple_answers)
+        multiple_answers.map do |single_answer|
+          {
+            JSON.parse(single_answer['name']).values.first =>
+              single_answer['children'].map { |c| JSON.parse(c).values.first }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tracksale/campaign.rb

@@ -21,6 +21,12 @@ module Tracksale
       create_from_response(campaign_found_by_name)
     end
 
+    def self.find_by_code(code)
+      campaign_found_by_code = client.get('campaign/' + code.to_s).first
+      return nil if campaign_found_by_code.nil?
+      create_from_response(campaign_found_by_code)
+    end
+
     def self.all
       raw_all.map { |campaign| create_from_response(campaign) }
     end

data/lib/tracksale/configuration.rb

@@ -7,7 +7,7 @@ module Tracksale
       @client ||= Tracksale::Client
     end
 
-    def force_dummy_client(on=true)
+    def force_dummy_client(on = true)
       @client = on ?
         Tracksale::DummyClient :
         Tracksale::Client

data/lib/tracksale/dummy_client.rb

@@ -1,19 +1,21 @@
 module Tracksale
   class DummyClient
     class << self
-      attr_accessor :response #Easy way to force a response
+      attr_accessor :response # Easy way to force a response
     end
 
     def initialize
       puts 'running tracksale dummy client, do not expect real responses.' if $DEBUG
     end
 
-    def get(endpoint_path, extra_headers = {}) #maintaining the same method signature as the real client
-      self.response
+    # maintaining the same method signature as the real client
+    def get(_endpoint_path, _extra_headers = {})
+      response
     end
 
-    def post(endpoint_path, body, extra_headers = {}) #maintaining the same method signature as the real client
-      self.response
+    # maintaining the same method signature as the real client
+    def post(_endpoint_path, _body, _extra_headers = {})
+      response
     end
 
     def default_response_object
@@ -23,11 +25,11 @@ module Tracksale
         true
       end
 
-      return response
+      response
     end
 
     def response
-      #definies a default valid response unless explicity defined.
+      # definies a default valid response unless explicity defined.
       self.class.response || default_response_object
     end
   end

data/lib/tracksale.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 require 'tracksale/configuration'
 require 'tracksale/client'
+require 'tracksale/answer'
 require 'tracksale/dummy_client'
 require 'tracksale/campaign'
 

data/test/test_tracksale.rb

@@ -11,9 +11,9 @@ class TracksaleTest < Minitest::Test
   end
 
   def test_configure_client
-    Tracksale.configure {|c| c.force_dummy_client(false) } #default
+    Tracksale.configure { |c| c.force_dummy_client(false) } # default
     assert_equal Tracksale::Client, Tracksale.configuration.client
-    Tracksale.configure {|c| c.force_dummy_client }
+    Tracksale.configure(&:force_dummy_client)
     assert_equal Tracksale::DummyClient, Tracksale.configuration.client
   end
 end

data/test/test_tracksale_answer.rb

@@ -0,0 +1,88 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'tracksale'
+
+class TestTracksaleAnswer < Minitest::Test
+  def setup
+    Tracksale.configure { |c| c.key = 'foobar'; c.force_dummy_client(false) }
+
+    body_for_campaign = '[{"name":"random - name",' \
+    '"code":7, "detractors":1,' \
+    '"passives":2, "promoters":3 }]'
+
+    stub_request(:get, 'http://api.tracksale.co/v2/campaign/7')
+      .with(headers: { 'authorization' => 'bearer foobar' })
+      .to_return(body: body_for_campaign,
+                 headers: { content_type: 'application/json' }, status: 200)
+
+    stub_request(:get, 'http://api.tracksale.co/v2/report/answer?tags=true&limit=' + Tracksale::Answer::LIMIT.to_s)
+      .with(headers: { 'authorization' => 'bearer foobar' })
+      .to_return(body: '[{
+        "time": 1532611646,
+        "type": "Email",
+        "name": "Um Dois Tres Quatro",
+        "email": "emailaleatorio@gmail.com",
+        "identification": null,
+        "phone": null,
+        "alternative_email": null,
+        "alternative_phone": null,
+        "nps_answer": 10,
+        "last_nps_answer": null,
+        "nps_comment": null,
+        "campaign_name": "Campanha de Teste",
+        "campaign_code": 7,
+        "id": 11112222,
+        "deadline": null,
+        "elapsed_time": 116,
+        "dispatch_time": null,
+        "reminder_time": null,
+        "status": "Não precisa contatar",
+        "priority": "Nenhuma",
+        "assignee": "Boris",
+        "picture": null,
+        "tags": [
+            {
+                "name": "test1",
+                "value": "test2"
+            },
+            {
+                "name": "test3",
+                "value": "test4"
+            }
+        ],
+        "categories": [],
+        "justifications": [
+            {
+                "name": "{\"pt-br\":\"foo\"}",
+                "children": [
+                    "{\"pt-br\":\"bar\"}",
+                    "{\"pt-br\":\"bar2\"}",
+                    "{\"pt-br\":\"bar3\"}"
+                ]
+            }
+       ]
+    }
+]',
+                 headers: { content_type: 'application/json' }, status: 200)
+  end
+
+  def test_answer_tags
+    assert subject.respond_to? :tags
+    expected_tags = { 'test1' => 'test2', 'test3' => 'test4' }
+    assert_equal expected_tags, subject.tags
+  end
+
+  def test_justifications
+    assert subject.respond_to? :justifications
+    expected_justifications = [{ 'foo' => %w[bar bar2 bar3] }]
+    assert_equal expected_justifications, subject.justifications
+  end
+
+  def test_campaign
+    assert subject.campaign.is_a? Tracksale::Campaign
+  end
+
+  def subject
+    Tracksale::Answer.all.first
+  end
+end

data/test/test_tracksale_campaign.rb

@@ -6,12 +6,19 @@ class TestTracksaleCampaign < Minitest::Test
   def setup
     Tracksale.configure { |c| c.key = 'foobar'; c.force_dummy_client(false) }
 
+    body_for_campaign = '[{"name":"random - name",' \
+      '"code":1234, "detractors":1,' \
+      '"passives":2, "promoters":3 }]'
+
     stub_request(:get, 'http://api.tracksale.co/v2/campaign')
       .with(headers: { 'authorization' => 'bearer foobar' })
-      .to_return(body: '[{"name":"random - name",' \
-      '"code":1234, "detractors":1,' \
-      '"passives":2, "promoters":3 }]',
-    headers: { content_type: 'application/json' }, status: 200)
+      .to_return(body: body_for_campaign,
+                 headers: { content_type: 'application/json' }, status: 200)
+
+    stub_request(:get, 'http://api.tracksale.co/v2/campaign/771')
+      .with(headers: { 'authorization' => 'bearer foobar' })
+      .to_return(body: body_for_campaign,
+                 headers: { content_type: 'application/json' }, status: 200)
 
     stub_dispatch(121, 200, '{ "msg": "scheduled" }')
     stub_dispatch(123, 400, '{ "error": "Invalid Time"}')
@@ -22,9 +29,9 @@ class TestTracksaleCampaign < Minitest::Test
     url = 'http://api.tracksale.co/v2/campaign/' + code.to_s + '/dispatch'
     stub_request(:post, url)
       .with(headers: { 'authorization' => 'bearer foobar',
-      'content-type' => 'application/json' }, body: '"foo"')
+                       'content-type' => 'application/json' }, body: '"foo"')
       .to_return(body: body,
-      headers: { content_type: 'application/json' }, status: status)
+                 headers: { content_type: 'application/json' }, status: status)
   end
 
   def test_dispatch_successful
@@ -77,6 +84,11 @@ class TestTracksaleCampaign < Minitest::Test
     assert Tracksale::Campaign.all.first.is_a? Tracksale::Campaign
   end
 
+  def test_find_by_code
+    assert Tracksale::Campaign.find_by_code(771).respond_to? :name
+    assert_equal 'random - name', Tracksale::Campaign.find_by_code(771).name
+  end
+
   private
 
   def subject

data/test/test_tracksale_dummyclient.rb

@@ -1,6 +1,6 @@
 class TestTracksaleDummyClient < Minitest::Test
   def setup
-    Tracksale.configure { |c| c.force_dummy_client }
+    Tracksale.configure(&:force_dummy_client)
   end
 
   def test_campaign_all_dummy
@@ -13,16 +13,16 @@ class TestTracksaleDummyClient < Minitest::Test
   end
 
   def test_campaign_dispatch_dummy
-    assert_equal Hash.new, Tracksale::Campaign.schedule_dispatch('code','body')
+    assert_equal({}, Tracksale::Campaign.schedule_dispatch('code', 'body'))
   end
 
   def test_allow_explict_response
     response = Object.new
-    response.send :define_singleton_method, :success?, proc {true}
-    Tracksale::DummyClient.response=response
+    response.send :define_singleton_method, :success?, (proc { true })
+    Tracksale::DummyClient.response = response
 
-    assert_equal response,Tracksale::Campaign.schedule_dispatch('code','body')
+    assert_equal response, Tracksale::Campaign.schedule_dispatch('code', 'body')
 
-    Tracksale::DummyClient.response=nil # revert to default
+    Tracksale::DummyClient.response = nil # revert to default
   end
 end

data/tracksale.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'tracksale'
-  s.version     = '0.0.4'
+  s.version     = '0.0.5'
   s.licenses    = ['MIT']
   s.summary     = 'Integration gem for tracksale api v2'
   s.description = 'Integration gem for tracksale api v2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracksale
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Estudar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -92,11 +92,13 @@ files:
 - README.md
 - Rakefile
 - lib/tracksale.rb
+- lib/tracksale/answer.rb
 - lib/tracksale/campaign.rb
 - lib/tracksale/client.rb
 - lib/tracksale/configuration.rb
 - lib/tracksale/dummy_client.rb
 - test/test_tracksale.rb
+- test/test_tracksale_answer.rb
 - test/test_tracksale_campaign.rb
 - test/test_tracksale_dummyclient.rb
 - tracksale.gemspec
@@ -127,5 +129,6 @@ specification_version: 4
 summary: Integration gem for tracksale api v2
 test_files:
 - test/test_tracksale.rb
+- test/test_tracksale_answer.rb
 - test/test_tracksale_campaign.rb
 - test/test_tracksale_dummyclient.rb