chargehound 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8cdd2963d9a13ce6a5acc47fc2b87e3a7bdf243
+  data.tar.gz: 45cbe62923b0a463870ac45d8f8ed2020d0fe507
+SHA512:
+  metadata.gz: c8f66046cf127db5a9c59d023c1c98c96ec9b76937505026d4ed5e7ef4dd4a0b9a92b28654626ecf4c846d2a1fe38465101199043dd965ec94409ed3fbdc978b
+  data.tar.gz: d950e221a03c6764ac41923f777bd16980632999dc1263e8580fa4e885e6a7b4980168b6b60ff85d9de379e801aa711ee4956d2480c44d44ea46aceffe3c1188

data/.gitignore

@@ -0,0 +1,5 @@
+/Gemfile.lock
+.rvmrc
+.bundle
+Gemfile.lock
+vendor

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/MethodLength:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - jruby-19mode
+  - jruby-9.0.5.0
+
+sudo: false
+
+script: bundle exec rake test

data/CHANGELOG

@@ -0,0 +1,2 @@
+1.0.0 April, 2016
+  - Initial release with disputes API

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2016 Chargehound (https://www.chargehound.com)
+
+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,35 @@
+# Chargehound ruby bindings
+
+[![Build Status](https://travis-ci.org/chargehound/chargehound-ruby.svg?branch=master)](https://travis-ci.org/chargehound/chargehound-ruby)
+
+<!-- ## Installation
+
+`gem install chargehound` -->
+
+## Usage
+
+Import chargehound and set your API key.
+
+```ruby
+require 'chargehound'
+Chargehound.api_key = '{ YOUR_API_KEY }'
+```
+
+<!-- ## Resources
+
+[Disputes](https://www.chargehound.com/docs/?ruby#disputes) -->
+
+## Development
+
+To build and install from the latest source:
+
+```bash
+$ git clone git@github.com:chargehound/chargehound-ruby.git
+$ bundle install
+```
+
+Run tests:
+
+```bash
+$ bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |test|
+  test.libs.push 'lib', 'test'
+  test.pattern = './test/**/*_test.rb'
+end
+
+task default: [:rubocop, :test]

data/chargehound.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'chargehound/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'chargehound'
+  spec.version     = Chargehound::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.authors     = ['Chargehound']
+  spec.email       = ['support@chargehound.com']
+  spec.homepage    = 'https://www.chargehound.com'
+  spec.summary     = 'Ruby bindings for the Chargehound API'
+  spec.description = 'Automatically fight disputes in Stripe'
+  spec.license     = 'MIT'
+
+  spec.add_dependency 'typhoeus', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rubocop', '~> 0.39'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+end

data/example/submit_dispute.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+# import Chargehound and set your API key
+require 'chargehound'
+Chargehound.api_key = ENV['CHARGEHOUND_API_KEY']
+
+# List currently active disputes and then submit
+# the most recent with the 'crowdfunding' template
+# and update the `customer_ip` evidence field.
+disputes = Chargehound::Disputes.list
+first = disputes['data'][0]
+submitted = Chargehound::Disputes.submit(first['id'],
+                                         template: 'crowdfunding',
+                                         fields: {
+                                           'customer_ip' => '100'
+                                         })
+
+puts "Submitted with fields: #{submitted['fields']}"

data/lib/chargehound.rb

@@ -0,0 +1,13 @@
+require 'chargehound/disputes'
+require 'chargehound/error'
+
+# Chargehound Ruby bindings
+module Chargehound
+  @host = 'api.chargehound.com'
+  @base_path = '/v1/'
+  @api_key = ''
+
+  class << self
+    attr_accessor :api_key, :host, :base_path
+  end
+end

data/lib/chargehound/api_request.rb

@@ -0,0 +1,76 @@
+require 'base64'
+require 'chargehound/error'
+require 'chargehound/version'
+require 'json'
+require 'typhoeus'
+
+module Chargehound
+  # Send a request to the Chargehound API
+  class ApiRequest
+    def initialize(http_method, path, opts = {})
+      @request = build_request http_method, path, opts
+    end
+
+    def run
+      response = @request.run
+
+      body = parse_request_body response.body
+
+      unless response.success?
+        raise ChargehoundError.create_chargehound_error body
+      end
+
+      body
+    end
+
+    def build_headers(opts)
+      headers = {
+        'Accept' => 'application/json',
+        'Authorization' =>
+          "Basic #{Base64.encode64(Chargehound.api_key + ':').chomp}",
+        'User-Agent' => "Chargehound/v1 RubyBindings/#{VERSION}"
+      }
+      opts[:body] && headers['Content-Type'] = 'application/json'
+      headers
+    end
+
+    def build_body(req_opts, http_method, opts)
+      if [:post, :patch, :put, :delete].include? http_method
+        req_body = build_request_body opts[:body]
+        req_opts.update body: req_body
+      end
+    end
+
+    def build_opts(http_method, opts)
+      query_params = opts[:query_params] || {}
+      headers = build_headers opts
+      req_opts = {
+        method: http_method,
+        headers: headers,
+        params: query_params
+      }
+      build_body req_opts, http_method, opts
+      req_opts
+    end
+
+    def build_request(http_method, path, opts = {})
+      url = build_request_url path
+      http_method = http_method.to_sym.downcase
+      req_opts = build_opts http_method, opts
+
+      Typhoeus::Request.new(url, req_opts)
+    end
+
+    def build_request_url(path)
+      'https://' + Chargehound.host + Chargehound.base_path + path
+    end
+
+    def build_request_body(body)
+      body.to_json
+    end
+
+    def parse_request_body(body)
+      JSON.parse body
+    end
+  end
+end

data/lib/chargehound/disputes.rb

@@ -0,0 +1,69 @@
+require 'chargehound/api_request'
+
+module Chargehound
+  # Access the Chargehound dispute resource
+  class Disputes
+    # A list of disputes
+    # This endpoint will list all the disputes that we have synced from Stripe.
+    # By default the disputes will be ordered by `created` with the most recent
+    # dispute first. { }`has_more` will be `true` if more results are available.
+    # @option [Hash] params the optional parameters
+    # @option params [Float] :limit Maximum number of disputes to return.
+    #   Default is 20, maximum is 100.
+    # @option params [String] :starting_after A dispute id.
+    #   Fetch disputes created after this dispute.
+    # @option params [String] :ending_before A dispute id.
+    #   Fetch disputes created before this dispute.
+    # @return [Disputes]
+    def self.list(params = {})
+      ApiRequest.new(:get, 'disputes', query_params: params).run
+    end
+
+    # Retrieve a dispute
+    # This endpoint will return a single dispute.
+    # @param dispute_id A dispute id
+    # @return [Dispute]
+    def self.retrieve(dispute_id)
+      ApiRequest.new(:get, "disputes/#{dispute_id}").run
+    end
+
+    # Submitting a dispute
+    # You will want to submit the dispute through Chargehound after you recieve
+    # a notification from Stripe of a new dispute. With one `POST` request
+    # you can update a dispute with the evidence fields and send the generated
+    # response to Stripe.
+    # The response will have a `201` status if the submit was successful.
+    # The dispute will also be in the submitted state.
+    # @param dispute_id A dispute id
+    # @option [Hash] update  A dispute update object
+    # @option update [String] :template The id of the template to use.
+    # @option update [Object] :fields Key value pairs to hydrate the
+    #   template's evidence fields.
+    # @option update [String] :customer_name Update the customer name.
+    #   Will also update the customer name in the evidence fields.
+    # @option update [String] :customer_email Update the customer email.
+    #   Will also update the customer email in the evidence fields.
+    #   Must be a valid email address.
+    # @return [Dispute]
+    def self.submit(dispute_id, update = {})
+      ApiRequest.new(:post, "disputes/#{dispute_id}/submit", body: update).run
+    end
+
+    # Updating a dispute
+    # You can update the template and the fields on a dispute.
+    # @param dispute_id A dispute id
+    # @option [Hash] update  A dispute update object
+    # @option update [String] :template The id of the template to use.
+    # @option update [Object] :fields Key value pairs to hydrate the template's
+    #   evidence fields.
+    # @option update [String] :customer_name Update the customer name.
+    #   Will also update the customer name in the evidence fields.
+    # @option update [String] :customer_email Update the customer email.
+    #   Will also update the customer email in the evidence fields.
+    #   Must be a valid email address.
+    # @return [Dispute]
+    def self.update(dispute_id, update = {})
+      ApiRequest.new(:put, "disputes/#{dispute_id}", body: update).run
+    end
+  end
+end

data/lib/chargehound/error.rb

@@ -0,0 +1,30 @@
+module Chargehound
+  # Cast Chargehound API errors to custom error types
+  class ChargehoundError < StandardError
+    attr_reader :status, :message
+
+    def initialize(error_response)
+      @message = error_response['message']
+      @status = error_response['status']
+      status_string = @status.nil? ? '' : "(Status #{@status}) "
+      super("#{status_string}#{message}")
+    end
+
+    def self.create_chargehound_error(error_response)
+      error = error_response['error']
+      case error['status']
+      when 401
+        ChargehoundAuthenticationError.new(error)
+      when 403
+        ChargehoundAuthenticationError.new(error)
+      when 400
+        ChargehoundBadRequestError.new(error)
+      else
+        ChargehoundError.new(error)
+      end
+    end
+  end
+
+  class ChargehoundAuthenticationError < ChargehoundError; end
+  class ChargehoundBadRequestError < ChargehoundError; end
+end

data/lib/chargehound/version.rb

@@ -0,0 +1,3 @@
+module Chargehound
+  VERSION = '1.0.0'.freeze
+end

data/test/chargehound_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+original_host = Chargehound.host
+
+auth_header = {
+  'Authorization' => 'Basic QVBJX0tFWTo='
+}
+
+describe Chargehound do
+  after do
+    Chargehound.api_key = ''
+    Chargehound.host = original_host
+    WebMock.reset!
+  end
+
+  it 'can set the API key on the module' do
+    Chargehound.api_key = 'API_KEY'
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: auth_header)
+           .to_return(body: {}.to_json)
+
+    Chargehound::Disputes.list
+    assert_requested stub
+  end
+
+  it 'can set the base host on the module' do
+    Chargehound.host = 'test'
+    stub = stub_request(:get, 'https://test/v1/disputes')
+           .to_return(body: {}.to_json)
+
+    Chargehound::Disputes.list
+    assert_requested stub
+  end
+end

data/test/disputes_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+get_headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'Basic QVBJX0tFWTo=',
+  'User-Agent' => 'Chargehound/v1 RubyBindings/1.0.0'
+}
+
+post_headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'Basic QVBJX0tFWTo=',
+  'Content-Type' => 'application/json',
+  'User-Agent' => 'Chargehound/v1 RubyBindings/1.0.0'
+}
+
+dispute_update = {
+  fields: {
+    'customer_name' => 'Susie'
+  }
+}
+
+dispute_response = {
+  'id' => 'dp_123'
+}.to_json
+
+describe Chargehound::Disputes do
+  before do
+    Chargehound.api_key = 'API_KEY'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it 'can list disputes' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: get_headers)
+           .to_return(body: dispute_response)
+
+    Chargehound::Disputes.list
+    assert_requested stub
+  end
+
+  it 'can retrieve a dispute' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes/dp_123')
+           .with(headers: get_headers)
+           .to_return(body: dispute_response)
+
+    Chargehound::Disputes.retrieve('dp_123')
+    assert_requested stub
+  end
+
+  it 'can submit a dispute' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers, body: dispute_update.to_json)
+           .to_return(body: dispute_response)
+
+    Chargehound::Disputes.submit('dp_123', dispute_update)
+    assert_requested stub
+  end
+
+  it 'can update a dispute' do
+    stub = stub_request(:put, 'https://api.chargehound.com/v1/disputes/dp_123')
+           .with(headers: post_headers, body: dispute_update.to_json)
+           .to_return(body: dispute_response)
+
+    Chargehound::Disputes.update('dp_123', dispute_update)
+    assert_requested stub
+  end
+end

data/test/error_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+error_response = {
+  'error' => {
+    'status' => 400,
+    'message' => 'Bad Request'
+  }
+}
+
+describe Chargehound::ChargehoundError do
+  before do
+    Chargehound.api_key = 'API_KEY'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it 'should propagate errors' do
+    stub_request(:any, 'https://api.chargehound.com/v1/disputes').to_raise(StandardError)
+
+    assert_raises(StandardError, proc { Chargehound::Disputes.list })
+  end
+
+  it 'should return typed chargehound errors from the API' do
+    stub_request(:any, 'https://api.chargehound.com/v1/disputes')
+      .to_return(status: 400, body: error_response.to_json)
+
+    # `assert_raises` doesn't like Chargehound::ChargehoundBadRequestError,
+    # so we simply write the code
+    begin
+      Chargehound::Disputes.list
+    rescue Chargehound::ChargehoundBadRequestError => error
+      assert(error.is_a?(Chargehound::ChargehoundBadRequestError))
+      assert_equal(400, error.status)
+      assert_equal('Bad Request', error.message)
+      assert_equal('(Status 400) Bad Request', error.to_s)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'chargehound'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'webmock/minitest'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: chargehound
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chargehound
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Automatically fight disputes in Stripe
+email:
+- support@chargehound.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chargehound.gemspec
+- example/submit_dispute.rb
+- lib/chargehound.rb
+- lib/chargehound/api_request.rb
+- lib/chargehound/disputes.rb
+- lib/chargehound/error.rb
+- lib/chargehound/version.rb
+- test/chargehound_test.rb
+- test/disputes_test.rb
+- test/error_test.rb
+- test/test_helper.rb
+homepage: https://www.chargehound.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Chargehound API
+test_files:
+- test/chargehound_test.rb
+- test/disputes_test.rb
+- test/error_test.rb
+- test/test_helper.rb