loyaltylion 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1f2523ea7f0d1cd590a1edcb16c5f4ad43a323b
+  data.tar.gz: e9ba5e1d307bb89716aecc71fb453881bc40b1b9
+SHA512:
+  metadata.gz: bbb91a32da8895518684e14d9d01cfeacec798976c1471e60c75fcc9859108e4e8f7dc634ead3e624b48d4406011c1cdb5dff417cd9ccc7494e16ede7ce601da
+  data.tar.gz: 9115e5997422e8533fdbe9182b5cb071e6a8f7fb16e535c6b5c278d9b24ada5e5afd505ed63ebe6095b6a97ff010aab6ae29028c2088dabda0ae4f3f147e3b26

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: hash_rockets
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: no_empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+  EnforcedStyle: no_empty_lines
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/Lambda:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'pry'
+  gem 'rspec', '~> 3.5.0'
+  gem 'webmock', '~> 2.1.0'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    loyaltylion (1.0.0)
+      httparty (>= 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    hashdiff (0.3.0)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    method_source (0.8.2)
+    multi_xml (0.5.5)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  loyaltylion!
+  pry
+  rake
+  rspec (~> 3.5.0)
+  webmock (~> 2.1.0)
+
+BUNDLED WITH
+   1.13.2

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(.)
+
+guard :rspec, :cmd => 'bundle exec rspec --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LoyaltyLion
+
+MIT License
+
+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,88 @@
+# LoyaltyLion ruby-client
+
+Use this to interact with the LoyaltyLion API from Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'loyaltylion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loyaltylion
+
+## Requirements
+
+* Ruby 1.9.3 or above
+
+## Usage
+
+Create a new instance of `LoyaltyLion` with your LoyaltyLion token and secret, which are available from your [dashboard](https://loyaltylion.com/login). You can then
+
+```ruby
+require 'loyaltylion'
+
+loyaltylion = LoyaltyLion.new(:token => 'abc', :secret => '123')
+```
+
+### Send a new order to LoyaltyLion
+
+```ruby
+loyaltylion.orders.create(
+  :merchant_id => '34b8c96a3b',
+  :customer_id => '71674',
+  :customer_email => 'alice@example.com',
+  :total => '59.95',
+  :total_shipping => '5.95',
+  :payment_status => 'unpaid',
+)
+```
+
+The `orders.create` method accepts a hash containing all [supported fields](https://loyaltylion.com/docs/tracking-activities-and-orders#using-the-orders-api)
+
+### Update an existing order
+
+LoyaltyLion order updates are idempotent `PUT` operations. You can push an update to an existing order any time the order changes - our API will determine what changed and perform the appropriate action (e.g. approving points).
+
+The first parameter should be the order's `merchant_id`, i.e. the id of the order in your system.
+
+```ruby
+loyaltylion.orders.update('34b8c96a3b',
+  :payment_status => 'paid',
+  :cancellation_status => 'not_cancelled',
+  :refund_status => 'not_refunded',
+  :total_paid => '59.95',
+  :total_refunded => '0',
+)
+```
+
+### Trigger an activity
+
+```ruby
+loyaltylion.activities.create(
+  :name => 'signup',
+  :customer_id => '1001',
+  :customer_email => 'alice@example.com',
+)
+```
+
+### Approve/decline an activity
+
+If you've triggered a custom activity with a `merchant_id`, you can approve or decline the activity at a later date using the `activities.approve` and `activities.decline` methods.
+
+These methods both expect the name of the custom activity (e.g. `review`) and the `merchant_id`.
+
+```ruby
+loyaltylion.activities.approve('review', '1001')
+# or...
+loyaltylion.activities.decline('review', '1001')
+```
+
+### Changelog
+
+* v1.0.0 - overhaul client API, bring in-line with v2 LoyaltyLion API

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/loyaltylion.rb

@@ -0,0 +1,8 @@
+require 'loyaltylion/version'
+require 'loyaltylion/client'
+
+require 'loyaltylion/models/order'
+require 'loyaltylion/models/activity'
+
+module LoyaltyLion
+end

data/lib/loyaltylion/client.rb

@@ -0,0 +1,57 @@
+require 'httparty'
+require 'json'
+require 'loyaltylion/version'
+require 'loyaltylion/errors'
+
+module LoyaltyLion
+  class Client
+    include HTTParty
+    base_uri 'https://api.loyaltylion.com/v2'
+
+    attr_reader :token, :secret
+
+    def initialize(opts = {})
+      @token = opts[:token]
+      @secret = opts[:secret]
+    end
+
+    def orders
+      LoyaltyLion::Order.new(self)
+    end
+
+    def activities
+      LoyaltyLion::Activity.new(self)
+    end
+
+    def request(opts)
+      method = opts[:method] || :get
+      path = opts[:path]
+      body = opts[:body] || {}
+      headers = {
+        'user-agent' => "LoyaltyLion Ruby v#{LoyaltyLion::VERSION}",
+      }
+
+      unless body.empty?
+        headers['content-type'] = 'application/json'
+        body = JSON.generate(body)
+      end
+
+      res = self.class.send(method, path,
+        :basic_auth => {
+          :username => token,
+          :password => secret,
+        },
+        :headers => headers,
+        :body => body.empty? ? nil : body
+      )
+
+      if res.code >= 200 && res.code < 300
+        res.parsed_response
+      elsif res.code >= 400 && res.code < 500
+        raise LoyaltyLion::ClientError, res.parsed_response.inspect
+      else
+        raise LoyaltyLion::ServerError, res.parsed_response.inspect
+      end
+    end
+  end
+end

data/lib/loyaltylion/errors.rb

@@ -0,0 +1,4 @@
+module LoyaltyLion
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+end

data/lib/loyaltylion/models/activity.rb

@@ -0,0 +1,29 @@
+require 'loyaltylion/models/resource'
+
+module LoyaltyLion
+  class Activity < Resource
+    def create(data)
+      client.request(
+        :method => :post,
+        :path => '/activities',
+        :body => data,
+      )
+    end
+
+    def approve(name, merchant_id)
+      update(name, merchant_id, :state => 'approved')
+    end
+
+    def decline(name, merchant_id)
+      update(name, merchant_id, :state => 'declined')
+    end
+
+    def update(name, merchant_id, data)
+      client.request(
+        :method => :put,
+        :path => "/activities/#{name}/#{merchant_id}",
+        :body => data,
+      )
+    end
+  end
+end

data/lib/loyaltylion/models/order.rb

@@ -0,0 +1,21 @@
+require 'loyaltylion/models/resource'
+
+module LoyaltyLion
+  class Order < Resource
+    def create(data)
+      client.request(
+        :method => :post,
+        :path => '/orders',
+        :body => data,
+      )
+    end
+
+    def update(merchant_id, data)
+      client.request(
+        :method => :put,
+        :path => "/orders/#{merchant_id}",
+        :body => data,
+      )
+    end
+  end
+end

data/lib/loyaltylion/models/resource.rb

@@ -0,0 +1,11 @@
+module LoyaltyLion
+  class Resource
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    attr_reader :client
+  end
+end

data/lib/loyaltylion/version.rb

@@ -0,0 +1,3 @@
+module LoyaltyLion
+  VERSION = '1.0.0'
+end

data/loyaltylion.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'loyaltylion/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'loyaltylion'
+  gem.version = LoyaltyLion::VERSION
+  gem.author = 'LoyaltyLion'
+  gem.email = 'support@loyaltylion.com'
+  gem.description = 'Interact with LoyaltyLion from Ruby. See https://loyaltylion.com/docs for more'
+  gem.summary = 'Ruby bindings for the LoyaltyLion API'
+  gem.homepage = 'https://loyaltylion.com/docs'
+
+  gem.add_dependency('httparty', '>= 0.8.1')
+
+  gem.files = `git ls-files`.split("\n")
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/spec/loyaltylion/client_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+RSpec.describe LoyaltyLion::Client do
+  describe '#initialize' do
+    it 'can create a new client with token/secret' do
+      client = LoyaltyLion::Client.new(:token => 'abc', :secret => '123')
+
+      expect(client.token).to eq('abc')
+      expect(client.secret).to eq('123')
+    end
+  end
+
+  describe '#request' do
+    let(:client) { LoyaltyLion::Client.new(:token => 'abc', :secret => '123') }
+
+    context 'any request' do
+      before do
+        stub_request(:get, 'https://api.loyaltylion.com/v2/orders')
+      end
+
+      it 'makes request to specified endpoint' do
+        client.request(:method => :get, :path => '/orders')
+        expect(WebMock).to have_requested(:get, 'https://api.loyaltylion.com/v2/orders')
+      end
+
+      it 'authenticates with token/secret' do
+        client.request(:method => :get, :path => '/orders')
+        expect(WebMock).to have_requested(:get, 'https://api.loyaltylion.com/v2/orders').with(
+          :basic_auth => %w(abc 123),
+        )
+      end
+
+      it 'sets custom user agent' do
+        client.request(:method => :get, :path => '/orders')
+        expect(WebMock).to have_requested(:get, 'https://api.loyaltylion.com/v2/orders').with(
+          :headers => {
+            'user-agent' => 'LoyaltyLion Ruby v1.0.0',
+          },
+        )
+      end
+    end
+
+    context 'when request has a body' do
+      it 'sends body as JSON' do
+        stub_request(:post, 'https://api.loyaltylion.com/v2/orders')
+        client.request(:method => :post, :path => '/orders', :body => {
+          :merchant_id => 'xe8ae3fe',
+        })
+
+        expect(WebMock).to have_requested(:post, 'https://api.loyaltylion.com/v2/orders').with(
+          :headers => {
+            'content-type' => 'application/json',
+          },
+          :body => JSON.generate(:merchant_id => 'xe8ae3fe'),
+        )
+      end
+    end
+
+    context 'when API returns a 5xx response' do
+      it 'raises LoyaltyLion::ServerError' do
+        (500..510).each do |status|
+          stub_request(:get, 'https://api.loyaltylion.com/v2/orders').to_return(
+            :status => status,
+          )
+
+          expect { client.request(:method => :get, :path => '/orders') }.
+            to raise_error(LoyaltyLion::ServerError)
+        end
+      end
+    end
+
+    context 'when API returns a 4xx response' do
+      it 'raises LoyaltyLion::ClientError' do
+        (400..430).each do |status|
+          stub_request(:get, 'https://api.loyaltylion.com/v2/orders').to_return(
+            :status => status,
+          )
+
+          expect { client.request(:method => :get, :path => '/orders') }.
+            to raise_error(LoyaltyLion::ClientError)
+        end
+      end
+    end
+
+    context 'when API returns any other response' do
+      let(:body) do
+        { 'customers' => [{ 'merchant_id' => '1001' }] }
+      end
+
+      it 'returns response body' do
+        stub_request(:get, 'https://api.loyaltylion.com/v2/orders').to_return(
+          :status => 200,
+          :headers => { 'content-type' => 'application/json' },
+          :body => JSON.generate(body),
+        )
+
+        expect(
+          client.request(:method => :get, :path => '/orders'),
+        ).to eql(body)
+      end
+    end
+  end
+
+  describe 'resources' do
+    let(:client) { LoyaltyLion::Client.new(:token => 'abc', :secret => '123') }
+
+    describe '#orders' do
+      it 'returns an instance of LoyaltyLion::Order' do
+        expect(client.orders).to be_instance_of(LoyaltyLion::Order)
+      end
+
+      describe '#create' do
+        it 'makes request with order data' do
+          stub_request(:post, 'https://api.loyaltylion.com/v2/orders')
+          client.orders.create(:merchant_id => 'xe8ae3fe')
+
+          expect(WebMock).to have_requested(:post, 'https://api.loyaltylion.com/v2/orders').with(
+            :body => JSON.generate(:merchant_id => 'xe8ae3fe'),
+          )
+        end
+      end
+
+      describe '#update' do
+        it 'makes request with order merchant_id and data' do
+          stub_request(:put, 'https://api.loyaltylion.com/v2/orders/xe8ae3fe')
+          client.orders.update('xe8ae3fe', :total_paid => '69.99')
+
+          expect(WebMock).to have_requested(:put, 'https://api.loyaltylion.com/v2/orders/xe8ae3fe').
+            with(
+              :body => JSON.generate(:total_paid => '69.99'),
+            )
+        end
+      end
+    end
+
+    describe '#activities' do
+      it 'returns an instance of LoyaltyLion::Activity' do
+        expect(client.activities).to be_instance_of(LoyaltyLion::Activity)
+      end
+
+      describe '#create' do
+        it 'makes POST request with activity data' do
+          stub_request(:post, 'https://api.loyaltylion.com/v2/activities')
+          client.activities.create(:name => 'review', :merchant_id => 'abc')
+
+          expect(WebMock).to have_requested(:post, 'https://api.loyaltylion.com/v2/activities').
+            with(
+              :body => JSON.generate(:name => 'review', :merchant_id => 'abc'),
+            )
+        end
+      end
+
+      describe '#update' do
+        it 'makes request with activity name, merchant_id and data' do
+          stub_request(:put, 'https://api.loyaltylion.com/v2/activities/review/abc1')
+          client.activities.update('review', 'abc1', :state => 'approved')
+
+          expect(WebMock).to have_requested(
+            :put,
+            'https://api.loyaltylion.com/v2/activities/review/abc1',
+          ).with(
+            :body => JSON.generate(:state => 'approved'),
+          )
+        end
+      end
+
+      describe '#approve' do
+        it 'makes PUT request to approve activity' do
+          stub_request(:put, 'https://api.loyaltylion.com/v2/activities/review/abc1')
+          client.activities.approve('review', 'abc1')
+
+          expect(WebMock).to have_requested(
+            :put,
+            'https://api.loyaltylion.com/v2/activities/review/abc1',
+          ).with(
+            :body => JSON.generate(:state => 'approved'),
+          )
+        end
+      end
+
+      describe '#decline' do
+        it 'makes PUT request to decline activity' do
+          stub_request(:put, 'https://api.loyaltylion.com/v2/activities/review/abc1')
+          client.activities.decline('review', 'abc1')
+
+          expect(WebMock).to have_requested(
+            :put,
+            'https://api.loyaltylion.com/v2/activities/review/abc1',
+          ).with(
+            :body => JSON.generate(:state => 'declined'),
+          )
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'loyaltylion'
+require 'webmock/rspec'
+
+RSpec.configure do |rspec|
+  rspec.color = true
+  rspec.tty = true
+  rspec.order = 'random'
+  rspec.backtrace_exclusion_patterns << /gems/
+
+  rspec.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  rspec.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: loyaltylion
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- LoyaltyLion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Interact with LoyaltyLion from Ruby. See https://loyaltylion.com/docs
+  for more
+email: support@loyaltylion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/loyaltylion.rb
+- lib/loyaltylion/client.rb
+- lib/loyaltylion/errors.rb
+- lib/loyaltylion/models/activity.rb
+- lib/loyaltylion/models/order.rb
+- lib/loyaltylion/models/resource.rb
+- lib/loyaltylion/version.rb
+- loyaltylion.gemspec
+- spec/loyaltylion/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://loyaltylion.com/docs
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the LoyaltyLion API
+test_files:
+- spec/loyaltylion/client_spec.rb
+- spec/spec_helper.rb