clutch-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6866a73737ccb27cbe8aa75d72d27fb662cba943
+  data.tar.gz: 225c68cf188687bed2a3cda6b5cc676098b464cd
+SHA512:
+  metadata.gz: efd6dca42abe0c396aa5e83994ae698cf804a08548e1289fc45476de9d109226caa8a80e6814e99f9c470943602b48aab61c420b449997ffb8f4f965e1de85c9
+  data.tar.gz: 66b2fca5c7518a3db8ff0353b50a9c040fafd1b3260ee3b8fb8c95ca00a6b5c9a75af77aa1d299ae00c066083d4ef25a4d0a7ac5fccc4826fe244a6b0c4c13d2

data/.env.test

@@ -0,0 +1,6 @@
+CLUTCH_API_KEY=INSERT_KEY
+CLUTCH_API_SECRET=INSERT_SECRET
+CLUTCH_API_BASE=https://api-test.profitpointinc.com:9002/merchant/
+CLUTCH_BRAND=INSERT_BRAND
+CLUTCH_LOCATION=INSERT_LOCATION
+CLUTCH_TERMINAL=INSERT_TERMINAL

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.pronto.yml

@@ -0,0 +1,7 @@
+verbose: false
+max_warnings: 150
+github:
+  slug: follain/clutch
+  access_token: ENV["GITHUB_ACCESS_TOKEN"]
+  api_endpoint: https://api.github.com/
+  web_endpoint: https://github.com/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,145 @@
+# Relaxed.Ruby.Style
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clutch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Samuel Martini
+
+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,41 @@
+# Clutch
+
+A simple client for the [Clutch API](http://stage-api-docs.clutch.com:8091/)
+
+[![CircleCI](https://circleci.com/gh/Follain/clutch/tree/master.svg?style=svg&circle-token=7bef3c072bded646e3b124860faf1bf67b902f98)](https://circleci.com/gh/Follain/clutch/tree/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clutch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clutch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clutch.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clutch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - 'if [ -n "$CI_PULL_REQUEST" ]; then PULL_REQUEST_ID=${CI_PULL_REQUEST##*/} bundle exec pronto run -f github_pr; fi'

data/clutch.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clutch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clutch-client"
+  spec.version       = Clutch::VERSION
+  spec.authors       = [""]
+  spec.email         = [""]
+
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.11"
+  spec.add_dependency "faraday_middleware", "~> 0.11"
+  spec.add_dependency "hashie", "~> 3.5"
+
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pronto", "~> 0.7"
+  spec.add_development_dependency "pronto-rubocop", "~> 0.7"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+end

data/lib/clutch/client.rb

@@ -0,0 +1,50 @@
+module Clutch
+  class Client
+    module NeverCapitalize
+      def capitalize!
+        super
+      end
+    end
+
+    HEADER_KEYS = %w[brand location terminal].map{ |key| key.extend(NeverCapitalize) }
+
+    attr_reader :connection
+
+    %w[api_key api_secret api_base brand location terminal card_set].each do |key|
+      define_method key do
+        Clutch.configuration.send("clutch_#{key}")
+      end
+    end
+
+
+    def headers
+      Hash[HEADER_KEYS.map{ |key| [key, send(key) ] }]
+    end
+
+    def initialize(connection = nil)
+      @connection = connection || build_connection
+    end
+
+    def build_connection
+      #opts = { ssl: { verify: false }, proxy: "http://localhost:8888" }
+      opts = {}
+      Faraday.new(api_base, opts) do |faraday|
+        faraday.adapter :net_http
+        faraday.request :json
+
+        faraday.response :mashify
+        faraday.response :json
+      end.tap do |faraday|
+        faraday.basic_auth api_key, api_secret
+      end
+    end
+
+    def post(path, hash)
+      response = connection.post(path, JSON.generate(hash)) do |conn|
+        conn.headers.merge!(headers)
+      end
+
+      response.body
+    end
+  end
+end

data/lib/clutch/configuration.rb

@@ -0,0 +1,23 @@
+module Clutch
+  class Configuration
+    attr_accessor :clutch_api_key,
+                  :clutch_api_secret,
+                  :clutch_api_base,
+                  :clutch_brand,
+                  :clutch_location,
+                  :clutch_terminal,
+                  :clutch_card_set,
+                  :http_proxy
+
+    def initialize
+      @clutch_api_key = nil
+      @clutch_api_secret = nil
+      @clutch_api_base = nil
+      @clutch_brand = nil
+      @clutch_location = nil
+      @clutch_terminal = nil
+      @clutch_card_set = nil
+      @http_proxy = nil
+    end
+  end
+end

data/lib/clutch/response_exception.rb

@@ -0,0 +1,9 @@
+module Clutch
+  class ResponseException < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+end

data/lib/clutch/version.rb

@@ -0,0 +1,3 @@
+module Clutch
+  VERSION = "0.1.0"
+end

data/lib/clutch.rb

@@ -0,0 +1,105 @@
+require "faraday"
+require "faraday_middleware"
+require "clutch/version"
+require "clutch/client"
+require "clutch/response_exception"
+require "clutch/configuration"
+
+module Clutch
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def client
+      @client ||= Client.new
+    end
+
+    def allocate(card_set_id:)
+      client.post "/allocate", cardSetId: card_set_id
+    end
+
+    def hold(card_number:, dollars:)
+      update_balance card_number, dollars, :hold
+    end
+
+    def history(card_number:)
+      client.post "/cardHistory", cardNumber: card_number
+    end
+
+    def issue(card_number:, dollars:, is_return_related: false)
+      update_balance card_number, dollars, "issue", is_return_related: is_return_related
+    end
+
+    def redeem(card_number:, dollars:)
+      update_balance card_number, dollars, "redeem"
+    end
+
+    def redeem_hold(card_number:, dollars:, hold_transaction_id:)
+      update_balance card_number, dollars, "redeem", hold_transaction_id: hold_transaction_id
+    end
+
+    def release_hold(card_number:, dollars:, hold_transaction_id:)
+      update_balance card_number, dollars, "redeem", hold_transaction_id: hold_transaction_id, release_hold_remainder: true
+    end
+
+    def search(filters:, returnFields:)
+      client.post "/search", filters: filters, returnFields: returnFields
+    end
+
+    def find(card_number:)
+      result = history(card_number: card_number)
+      if (result.success)
+        card = search(
+          filters: { cardNumber: card_number },
+          returnFields: {
+            balances: true,
+            checkouts: true,
+            customData: true,
+            activationDate: true
+          }
+        ).cards.first
+
+        card.activated = true
+        return card
+      end
+
+      case result.errorMessage
+      when 'Could not find the specified card.'
+        raise Clutch::ResponseException.new(result), result.errorMessage
+      when 'Could not find the account that goes with the specified card.'
+        return { cardNumber: card_number, activated: false, balances: [] }
+      else
+        raise Clutch::ResponseException.new(result), result.errorMessage
+      end
+    end
+
+    def validate(filters:, returnFields:, pin:)
+      response = client.post "/search", filters: filters, returnFields: returnFields, forcePinValidation: true, pin: pin
+      raise Clutch::ResponseException.new(response), response.errorMessage unless response.success?
+      response
+    end
+
+    private
+
+    def update_balance(card_number, dollars, action, hold_transaction_id: nil, is_return_related: false, release_hold_remainder: false)
+      client.post "/updateBalance",
+        cardNumber: card_number,
+        action: action,
+        redeemFromHoldTransactionId: hold_transaction_id,
+        releaseHoldRemainder: release_hold_remainder,
+        isReturnRelated: is_return_related,
+        amount: {
+          balanceType: "Currency",
+          balanceCode: "USD",
+          amount: dollars
+        }
+    end
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: clutch-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: ''
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test"
+- ".gitignore"
+- ".pronto.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- clutch.gemspec
+- lib/clutch.rb
+- lib/clutch/client.rb
+- lib/clutch/configuration.rb
+- lib/clutch/response_exception.rb
+- lib/clutch/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []