tracksale 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8695bde4a00982ac1f031c9640f99bcdc1ea5035
+  data.tar.gz: fdea0cf19cd340c25af8806d9965da41401cc4ad
+SHA512:
+  metadata.gz: '08a49e848d33033fc14577ed8811eee42c721157ddda393efe1ba435f6220c9891adfcd18bf9a89c2c96f258fcb25177a4513754621f524029c54ab9d19b94d8'
+  data.tar.gz: 77df3b07d468014360939c5dff9d6843982deba6e6414253c7bd408c836d0ceb92c5a72f6ba93899ab125151ba21be6c4013fa8a1d3658578a087ab987c6ea43

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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Fundação Estudar
+
+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,42 @@
+# Tracksale
+Tracksale v2 API integration gem.
+
+## Install
+
+1. Add `gem 'tracksale', github: 'estudar/tracksale'` into your Gemfile.
+2. run `bundle install`
+
+## Configure
+
+You must generate a Tracksale key on tracksale.co website and configure it on rails you can use an initializer.
+
+config/initializers/tracksale.rb
+```
+Tracksale.configure do |config|
+  config.key = 'YOUR_KEY_HERE'
+end
+```
+
+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
+```
+Tracksale::Campaign.find_by_name('foobar') => #<Tracksale::Campaign:0x00559c458ec128
+ @code=123,
+ @name="foobar",
+ @score={:detractors=>1, :passives=>2, :promoters=>3}>
+```
+
+## Debug
+
+You can enable the HTTParty debug on the request by using the '-d' option on IRB or Ruby
+
+## Limitations
+
+This gem is on early stages of development and you will only be able to:
+
+* Find campaigns by name ( `Tracksale::Campaign.find_by_name(name)` )
+* List all campaigns ( `Tracksale::Campaign.all` )
+
+Also you can only access 5 items from a campaign (name, code, detractors, passives and promoters).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/tracksale/campaign.rb

@@ -0,0 +1,35 @@
+module Tracksale
+  class Campaign
+    attr_accessor :name, :code, :score
+
+    def self.find_by_name(name)
+      campaign_found_by_name = raw_all.keep_if { |c| c['name'] == name }.first
+      return nil if campaign_found_by_name.nil?
+      create_from_response(campaign_found_by_name)
+    end
+
+    def self.all
+      raw_all.map { |campaign| create_from_response(campaign) }
+    end
+
+    def self.create_from_response(raw_reponse)
+      new.tap do |campaign|
+        campaign.name = raw_reponse['name']
+        campaign.code = raw_reponse['code']
+        campaign.score = {
+          detractors: raw_reponse['detractors'],
+          passives: raw_reponse['passives'],
+          promoters: raw_reponse['promoters']
+        }
+      end
+    end
+
+    def self.raw_all
+      client.get('campaign')
+    end
+
+    def self.client
+      Tracksale::Client.new
+    end
+  end
+end

data/lib/tracksale/client.rb

@@ -0,0 +1,27 @@
+module Tracksale
+  class Client
+    attr_accessor :key
+    attr_accessor :default_path
+    include HTTParty
+    # api.tracksale.co/v2/login
+    base_uri 'http://api.tracksale.co'
+
+    def initialize
+      if Tracksale.configuration.key.nil?
+        raise 'API Key not found , please configure as explained in the readme.'
+      end
+
+      @key = Tracksale.configuration.key
+      @default_path = '/v2/'
+    end
+
+    def get(endpoint_path, extra_headers = {})
+      headers = { 'authorization' => 'bearer ' + key }.merge(extra_headers)
+      request_params = {
+        headers: headers
+      }
+      request_params[:debug_output] = STDOUT if $DEBUG
+      self.class.get(default_path + endpoint_path, request_params)
+    end
+  end
+end

data/lib/tracksale/configuration.rb

@@ -0,0 +1,5 @@
+module Tracksale
+  class Configuration
+    attr_accessor :key
+  end
+end

data/lib/tracksale.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+require 'tracksale/configuration'
+require 'tracksale/client'
+require 'tracksale/campaign'
+
+module Tracksale
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/test/test_tracksale.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'tracksale'
+
+class TracksaleTest < Minitest::Test
+  def test_configure
+    Tracksale.configure do |config|
+      config.key = 'foobar'
+    end
+
+    assert_equal 'foobar', Tracksale::Client.new.key
+  end
+end

data/test/test_tracksale_campaign.rb

@@ -0,0 +1,55 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'tracksale'
+
+class TracksaleCampaignTest < Minitest::Test
+  def setup
+    Tracksale.configure { |c| c.key = 'foobar' }
+
+    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)
+  end
+
+  def test_return_right_amount_of_items
+    assert_equal 1, Tracksale::Campaign.all.size
+    assert !subject.nil?
+    assert Tracksale::Campaign.find_by_name('random - another name').nil?
+  end
+
+  def test_find_return_a_campaign
+    assert subject.is_a? Tracksale::Campaign
+  end
+
+  def test_campaign_has_a_name
+    assert subject.respond_to? :name
+    assert_equal 'random - name', subject.name
+  end
+
+  def test_campaign_has_a_code
+    assert subject.respond_to? :code
+    assert_equal 1234, subject.code
+  end
+
+  def test_campaign_scores
+    campaign = subject
+    assert campaign.respond_to? :score
+    expected_score = { detractors: 1, passives: 2, promoters: 3 }
+    assert_equal expected_score, campaign.score
+  end
+
+  def test_all_returns_campaigns
+    assert Tracksale::Campaign.all.first.is_a? Tracksale::Campaign
+  end
+
+  private
+
+  def subject
+    Tracksale::Campaign.find_by_name('random - name')
+  end
+end

data/tracksale.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'tracksale'
+  s.version     = '0.0.1'
+  s.licenses    = ['MIT']
+  s.summary     = 'Integration gem for tracksale api v2'
+  s.description = 'Integration gem for tracksale api v2'
+  s.authors     = ['Estudar']
+  s.email       = 'regis@estudar.org.br'
+  s.homepage    = 'https://github.com/estudar/tracksale'
+  s.metadata    = { 'source_code_uri' =>
+        'https://github.com/estudar/tracksale' }
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^test/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'webmock'
+
+  s.add_dependency 'httparty'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: tracksale
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Estudar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration gem for tracksale api v2
+email: regis@estudar.org.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tracksale.rb
+- lib/tracksale/campaign.rb
+- lib/tracksale/client.rb
+- lib/tracksale/configuration.rb
+- test/test_tracksale.rb
+- test/test_tracksale_campaign.rb
+- tracksale.gemspec
+homepage: https://github.com/estudar/tracksale
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/estudar/tracksale
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Integration gem for tracksale api v2
+test_files:
+- test/test_tracksale.rb
+- test/test_tracksale_campaign.rb