chargehound 2.2.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31be9dbdfb185724f781b20725eb877783e3c664
-  data.tar.gz: 9319f70f475d27941ba96704aec1eacf799ae49d
+SHA256:
+  metadata.gz: 3a82e732eb0a7cdf16eaf13488aa3802d99b14f39ea1270e588ac92f9e6ec7f9
+  data.tar.gz: a14307daea1deb3817aba7767d6f88bc0e84395af7502c55acbc5508415df4f1
 SHA512:
-  metadata.gz: f02ea14de6beeb51ab586ebd55a2be71b9e2ac0398b6a0f5350b16fbfbcfb723b6ba3185ef746aa38ad3682e1dc74ec19907d5d4997558c218fc81614a888930
-  data.tar.gz: 16ec1a8b42319611385c23586084898dc5be3ec2ebf17d85945d3ac2ff25981e1aa69c38f5c0318cabb9e8fb6a79ec9e24f3f102528cef2280b43d8247d93a41
+  metadata.gz: 3c2cc970865ac3e79011460b39636fd0fe4399abae617428fb4edd6a59a1ceeca1ae103fcad2fa89f0bfe272da1ae97b05379a6c253ff060e8d4b7544300c711
+  data.tar.gz: 0a821e6464dbac1257fcb0d73a91c58894e97ed2968729b00abdf8e2d311fd2812c5f45c3f7faafe51fc3722031c2138f94755b77e49cec0f6d7bc1e686c6019

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6']
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test

data/.github/workflows/rvm.yml

@@ -0,0 +1,36 @@
+name: JRuby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ 'jruby-9.2.9.0', 'jruby-head' ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+    - name: Install libraries
+      run: sudo apt install haveged
+    - uses: actions/checkout@v2
+    - name: Set up RVM
+      run: |
+        curl -sSL https://get.rvm.io | bash
+    - name: Set up Ruby
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        rvm install ${{ matrix.ruby }} --binary
+        rvm --default use ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        gem install bundler --no-document
+        bundle install
+    - name: Run test
+      run: |
+        source $HOME/.rvm/scripts/rvm
+        rake test

data/.rubocop.yml

@@ -1,5 +1,23 @@
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
 Style/SpecialGlobalVars:
   Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false

data/CHANGELOG

@@ -14,3 +14,13 @@
   - Add Accept endpoint
 2.2.0 November, 2017
   - Add support for overriding version
+2.2.1 Febuary, 2018
+  - Update rubocop version
+2.2.2 September, 2018
+  - Update docs
+2.3.0 April, 2019
+  - Add Correspondence model
+2.4.0 Sept, 2019
+  - Add PastPayment model
+2.5.0 Feb, 2021
+  - Surface error types

data/chargehound.gemspec

@@ -6,18 +6,18 @@ 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.required_ruby_version = '>= 2.0.0'
   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.description = 'Automatically fight disputes'
   spec.license     = 'MIT'
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '~> 5.8'
-  spec.add_development_dependency 'rake', '~> 11.1'
-  spec.add_development_dependency 'rubocop', '0.41.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
   spec.add_development_dependency 'webmock', '~> 2.3'
 
   spec.files         = `git ls-files`.split($/)

data/lib/chargehound/api_request.rb

@@ -39,10 +39,7 @@ module Chargehound
     end
 
     def build_http_opts
-      {
-        use_ssl: true,
-        read_timeout: Chargehound.timeout
-      }
+      { use_ssl: true, read_timeout: Chargehound.timeout }
     end
 
     def build_headers(body)
@@ -100,7 +97,15 @@ module Chargehound
     def convert(dict)
       case dict['object']
       when 'dispute'
-        dict['products'].map! { |item| Product.new(item) }
+        dict['products'] = dict.fetch('products', []).map { |item|
+          Product.new(item)
+        }
+        dict['correspondence'] = dict.fetch('correspondence', []).map { |item|
+          CorrespondenceItem.new(item)
+        }
+        dict['past_payments'] = dict.fetch('past_payments', []).map { |item|
+          PastPayment.new(item)
+        }
         Dispute.new(dict)
       when 'list'
         dict['data'].map! { |item| convert item }

data/lib/chargehound/disputes.rb

@@ -11,7 +11,8 @@ module Chargehound
     end
 
     # A list of disputes
-    # This endpoint will list all the disputes that we have synced from Stripe.
+    # This endpoint will list all the disputes that we have synced from your
+    # payment processor.
     # 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 query parameters
@@ -37,9 +38,9 @@ module Chargehound
 
     # 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.
+    # a webhook notification of a new dispute. With one `POST` request
+    # you can update a dispute with the evidence fields and submit the generated
+    # response.
     # 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

data/lib/chargehound/error.rb

@@ -1,11 +1,12 @@
 module Chargehound
   # Cast Chargehound API errors to custom error types
   class ChargehoundError < StandardError
-    attr_reader :status, :message
+    attr_reader :status, :message, :type
 
     def initialize(error_response)
       @message = error_response['message']
       @status = error_response['status']
+      @type = error_response['type']
       status_string = @status.nil? ? '' : "(Status #{@status}) "
       super("#{status_string}#{message}")
     end

data/lib/chargehound/models.rb

@@ -40,6 +40,12 @@ module Chargehound
   class Product < ChargehoundObject
   end
 
+  class CorrespondenceItem < ChargehoundObject
+  end
+
+  class PastPayment < ChargehoundObject
+  end
+
   # Expose response properties via this struct on response objects
   HTTPResponse = Struct.new(:status)
 end

data/lib/chargehound/version.rb

@@ -1,3 +1,3 @@
 module Chargehound
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/test/disputes_test.rb

@@ -75,18 +75,100 @@ dispute_with_product_info_response = {
   ]
 }
 
-dispute_response = {
+dispute_with_correspondence_info_update = {
+  fields: {
+    customer_name: 'Susie'
+  },
+  correspondence: [
+    {
+      to: 'customer@example.com',
+      from: 'noreply@example.com',
+      subject: 'Your Order',
+      body: 'Your order was received.',
+      caption: 'Order confirmation email.'
+    }, {
+      to: 'customer@example.com',
+      from: 'noreply@example.com',
+      subject: 'Your Order',
+      body: 'Your order was delivered.',
+      caption: 'Delivery confirmation email.'
+    }
+  ]
+}
+
+dispute_with_correspondence_info_response = {
+  id: 'dp_123',
+  object: 'dispute',
+  fields: {
+    customer_name: 'Susie'
+  },
+  correspondence: [
+    {
+      to: 'customer@example.com',
+      from: 'noreply@example.com',
+      subject: 'Your Order',
+      body: 'Your order was received.',
+      caption: 'Order confirmation email.'
+    }, {
+      to: 'customer@example.com',
+      from: 'noreply@example.com',
+      subject: 'Your Order',
+      body: 'Your order was delivered.',
+      caption: 'Delivery confirmation email.'
+    }
+  ]
+}
+
+dispute_with_past_payments_update = {
+  fields: {
+    customer_name: 'Susie'
+  },
+  past_payments: [
+    {
+      id: 'ch_1',
+      amount: 20_000,
+      currency: 'usd',
+      charged_at: '2019-09-10 11:09:41PM UTC'
+    }, {
+      id: 'ch_2',
+      amount: 50_000,
+      currency: 'usd',
+      charged_at: '2019-09-03 11:09:41PM UTC'
+    }
+  ]
+}
+
+dispute_with_past_payments_response = {
   id: 'dp_123',
   object: 'dispute',
-  products: []
+  fields: {
+    customer_name: 'Susie'
+  },
+  past_payments: [
+    {
+      id: 'ch_1',
+      amount: 20_000,
+      currency: 'usd',
+      charged_at: '2019-09-10 11:09:41PM UTC'
+    }, {
+      id: 'ch_2',
+      amount: 50_000,
+      currency: 'usd',
+      charged_at: '2019-09-03 11:09:41PM UTC'
+    }
+  ]
+}
+
+dispute_response = {
+  id: 'dp_123',
+  object: 'dispute'
 }
 
 dispute_list_response = {
   object: 'list',
   data: [{
     id: 'dp_123',
-    object: 'dispute',
-    products: []
+    object: 'dispute'
   }]
 }
 
@@ -145,7 +227,9 @@ describe Chargehound::Disputes do
       data: [{
         id: 'dp_123',
         object: 'dispute',
-        products: []
+        products: [],
+        correspondence: [],
+        past_payments: []
       }],
       response: {
         status: '200'
@@ -174,6 +258,24 @@ describe Chargehound::Disputes do
     assert_requested stub
   end
 
+  it 'can list disputes filtered by state' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes?state=needs_response')
+           .with(headers: get_headers)
+           .to_return(body: dispute_list_response.to_json)
+
+    Chargehound::Disputes.list(state: %w[needs_response])
+    assert_requested stub
+  end
+
+  it 'can list disputes filtered by multiple states' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes?state=needs_response&state=warning_needs_response')
+           .with(headers: get_headers)
+           .to_return(body: dispute_list_response.to_json)
+
+    Chargehound::Disputes.list(state: %w[needs_response warning_needs_response])
+    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)
@@ -242,6 +344,59 @@ describe Chargehound::Disputes do
     assert_requested stub
   end
 
+  it 'can submit a dispute with correspondence data' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers,
+                 body: dispute_with_correspondence_info_update.to_json)
+           .to_return(body: dispute_with_correspondence_info_response.to_json,
+                      status: 201)
+
+    Chargehound::Disputes.submit('dp_123',
+                                 dispute_with_correspondence_info_update)
+    assert_requested stub
+  end
+
+  it 'has a model for correspondence data' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers,
+                 body: dispute_with_correspondence_info_update.to_json)
+           .to_return(body: dispute_with_correspondence_info_response.to_json,
+                      status: 201)
+
+    dispute = Chargehound::Disputes.submit(
+      'dp_123', dispute_with_correspondence_info_update
+    )
+
+    assert_instance_of(Chargehound::CorrespondenceItem,
+                       dispute.correspondence[0])
+    assert_requested stub
+  end
+
+  it 'can submit a dispute with past payments data' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers,
+                 body: dispute_with_past_payments_update.to_json)
+           .to_return(body: dispute_with_past_payments_response.to_json,
+                      status: 201)
+
+    Chargehound::Disputes.submit('dp_123', dispute_with_past_payments_update)
+    assert_requested stub
+  end
+
+  it 'has a model for past payments data' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers,
+                 body: dispute_with_past_payments_update.to_json)
+           .to_return(body: dispute_with_past_payments_response.to_json,
+                      status: 201)
+
+    dispute = Chargehound::Disputes.submit('dp_123',
+                                           dispute_with_past_payments_update)
+
+    assert_instance_of(Chargehound::PastPayment, dispute.past_payments[0])
+    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)
@@ -260,4 +415,15 @@ describe Chargehound::Disputes do
     Chargehound::Disputes.update('dp_123', dispute_with_product_info_update)
     assert_requested stub
   end
+
+  it 'can update a dispute with correspondence data' do
+    stub = stub_request(:put, 'https://api.chargehound.com/v1/disputes/dp_123')
+           .with(headers: post_headers,
+                 body: dispute_with_correspondence_info_update.to_json)
+           .to_return(body: dispute_response.to_json)
+
+    Chargehound::Disputes.update('dp_123',
+                                 dispute_with_correspondence_info_update)
+    assert_requested stub
+  end
 end

data/test/error_test.rb

@@ -7,6 +7,14 @@ error_response = {
   }
 }
 
+error_response_typed = {
+  'error' => {
+    'status' => 400,
+    'message' => 'Bad Request',
+    'type' => 'invalid_request'
+  }
+}
+
 describe Chargehound::ChargehoundError do
   before do
     Chargehound.api_key = 'API_KEY'
@@ -19,7 +27,13 @@ describe Chargehound::ChargehoundError do
   it 'should propagate errors' do
     stub_request(:any, 'https://api.chargehound.com/v1/disputes').to_raise(StandardError)
 
-    assert_raises(StandardError, proc { Chargehound::Disputes.list })
+    # `assert_raises` has trouble on jruby,
+    # so we simply write the code
+    begin
+      Chargehound::Disputes.list
+    rescue StandardError => error
+      assert(error.is_a?(StandardError))
+    end
   end
 
   it 'should return typed chargehound errors from the API' do
@@ -38,6 +52,35 @@ describe Chargehound::ChargehoundError do
     end
   end
 
+  it 'should surface the error type' do
+    stub_request(:any, 'https://api.chargehound.com/v1/disputes').to_raise(StandardError)
+
+    # `assert_raises` has trouble on jruby,
+    # so we simply write the code
+    begin
+      Chargehound::Disputes.list
+    rescue StandardError => error
+      assert(error.is_a?(StandardError))
+    end
+  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_typed.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('invalid_request', error.type)
+      assert_equal('(Status 400) Bad Request', error.to_s)
+    end
+  end
+
   it 'should throw a typed error on timeout' do
     stub_request(:any, 'https://api.chargehound.com/v1/disputes').to_timeout
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chargehound
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Chargehound
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Automatically fight disputes in Stripe
+description: Automatically fight disputes
 email:
 - support@chargehound.com
 executables: []
@@ -88,9 +88,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/ruby.yml"
+- ".github/workflows/rvm.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -112,7 +113,7 @@ homepage: https://www.chargehound.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,16 +121,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby bindings for the Chargehound API
 test_files:

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3.0
-  - 2.3.1
-  - jruby-9.1.5.0
-
-sudo: false
-
-script: bundle exec rake test