chargehound 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be69ff643cea24f8f25e438f5a168b97b5a594b1
-  data.tar.gz: 81c55ba4fba079039d6e1cdbe9484e07d8e1feda
+  metadata.gz: aa72d540f445fd4d59ce60f6b24fb5dbe6caa79d
+  data.tar.gz: 9667364aa8f85ea683df1c2d4fcea9430f025747
 SHA512:
-  metadata.gz: ed24f3d055251bffe65d6e5bdd1177b7ca6b6faff25b82b0ec74d0523c80f8eab8b74e9fa011dd3049e188088454cffdb18240f7831c2a69a7faaef30b083077
-  data.tar.gz: 1092f2d0b94a1601501255835b04ad67e4a0377a6ed1bb1a162a246c7d8186154bb13c1a62c504a960f2d65dc245e57ed25dc4806aa02b0872cdf397fcf415f9
+  metadata.gz: c403bacda18d58039275be0eb992b103d98efff3bfedb759d037ac72214e105da27252d4b1231e0b0fb2401362d4cda164b557147e04b6e1ad671089b7edc0c8
+  data.tar.gz: ab489aec72d890dd38bf8cd2ed6019fa0fa567f2704f8f016e2f290f24fd45a2e566cadd53aa2400e8fef8828246ef7d3ee03352fcb596810267c019c9ee450b

data/.travis.yml

@@ -1,13 +1,12 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
   - 2.3.0
-  - jruby-19mode
-  - jruby-9.0.5.0
+  - 2.3.1
+  - jruby-9.1.5.0
 
 sudo: false
 

data/CHANGELOG

@@ -4,3 +4,9 @@
   - Added APIs to pass product lists
 1.2.0 July, 2016
   - Added timeout option
+2.0.0 October, 2016
+  - Add Dispute create method
+  - Add Dispute response retrieve method
+  - Expose response status codes
+  - Drop CI support for Ruby 1.9.3
+  - Add typed response models

data/README.md

@@ -15,6 +15,33 @@ require 'chargehound'
 Chargehound.api_key = '{ YOUR_API_KEY }'
 ```
 
+### Requests
+
+Every resource is accessed via the Chargehound module.
+
+```ruby
+Chargehound::Disputes.submit('dp_123', {
+  fields: {
+    customer_name: 'Susie'
+  }
+})
+```
+
+### Responses
+
+Responses from the API are automatically parsed from JSON and returned as Ruby objects.
+
+Responses also include the HTTP status code on the response object as the status field.
+
+```ruby
+dispute = Chargehound::Disputes.retrieve('dp_123')
+
+puts dispute.state
+# 'needs_response'
+puts dispute.response.status
+# '200'
+```
+
 ## Documentation
 
 [Disputes](https://www.chargehound.com/docs/api/index.html?ruby#disputes)

data/chargehound.gemspec

@@ -14,8 +14,6 @@ Gem::Specification.new do |spec|
   spec.description = 'Automatically fight disputes in Stripe'
   spec.license     = 'MIT'
 
-  spec.add_dependency 'typhoeus', '<2.0'
-
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'rake', '~> 11.1'

data/lib/chargehound/api_request.rb

@@ -1,8 +1,8 @@
-require 'base64'
+require 'chargehound/models'
 require 'chargehound/error'
 require 'chargehound/version'
 require 'json'
-require 'typhoeus'
+require 'net/http'
 
 module Chargehound
   # Send a request to the Chargehound API
@@ -12,68 +12,109 @@ module Chargehound
     end
 
     def run
-      response = @request.run
-
-      raise ChargehoundError.create_timeout_error if response.timed_out?
-
-      body = parse_request_body response.body
+      host = @request.uri.host
+      port = @request.uri.port
+      Net::HTTP.start(host, port, build_http_opts) do |http|
+        begin
+          response = http.request @request
+          handle_response response
+        rescue Net::ReadTimeout
+          raise ChargehoundError.create_timeout_error
+        rescue Timeout::Error
+          raise ChargehoundError.create_timeout_error
+        end
+      end
+    end
 
-      unless response.success?
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        parse_response response
+      when Net::HTTPRequestTimeOut
+        raise ChargehoundError.create_timeout_error
+      else
+        body = JSON.parse response.body
         raise ChargehoundError.create_chargehound_error body
       end
+    end
 
-      body
+    def build_http_opts
+      {
+        use_ssl: true,
+        read_timeout: Chargehound.timeout
+      }
     end
 
-    def build_headers(opts)
+    def build_headers(body)
       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'
+      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
+    def build_body(body)
+      body.to_json if body
     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,
-        timeout: Chargehound.timeout
-      }
-      build_body req_opts, http_method, opts
-      req_opts
+    def build_request_instance(http_method, uri, body, headers)
+      case http_method
+      when :get
+        Net::HTTP::Get.new uri, headers
+      when :put
+        req = Net::HTTP::Put.new uri, headers
+        req.body = body
+        req
+      when :post
+        req = Net::HTTP::Post.new uri, headers
+        req.body = body
+        req
+      end
     end
 
     def build_request(http_method, path, opts = {})
-      url = build_request_url path
+      query_params = opts[:query_params] || {}
+      body = opts[:body]
       http_method = http_method.to_sym.downcase
-      req_opts = build_opts http_method, opts
 
-      Typhoeus::Request.new(url, req_opts)
+      uri = build_uri path, query_params
+      headers = build_headers body
+      body = build_body body
+
+      req = build_request_instance http_method, uri, body, headers
+      req.basic_auth Chargehound.api_key, ''
+      req
     end
 
-    def build_request_url(path)
-      'https://' + Chargehound.host + Chargehound.base_path + path
+    def build_uri(path, query_params)
+      url = 'https://' + Chargehound.host + Chargehound.base_path + path
+      uri = URI(url)
+      uri.query = URI.encode_www_form(query_params)
+      uri
     end
 
-    def build_request_body(body)
-      body.to_json
+    def convert(dict)
+      case dict['object']
+      when 'dispute'
+        dict['products'].map! { |item| Product.new(item) }
+        Dispute.new(dict)
+      when 'list'
+        dict['data'].map! { |item| convert item }
+        list = List.new(dict)
+        list
+      when 'response'
+        Response.new(dict)
+      else
+        ChargehoundObject.new
+      end
     end
 
-    def parse_request_body(body)
-      JSON.parse body
+    def parse_response(response)
+      body = JSON.parse response.body
+      body = convert body
+      body.response = HTTPResponse.new(response.code)
+      body
     end
   end
 end

data/lib/chargehound/disputes.rb

@@ -3,17 +3,18 @@ require 'chargehound/api_request'
 module Chargehound
   # Access the Chargehound dispute resource
   class Disputes
+    # Create a dispute
+    # @option [Hash] A dispute create object
+    # @return [Dispute]
+    def self.create(create = {})
+      ApiRequest.new(:post, 'disputes', body: create).run
+    end
+
     # 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.
+    # @option [Hash] params the query parameters
     # @return [Disputes]
     def self.list(params = {})
       ApiRequest.new(:get, 'disputes', query_params: params).run
@@ -21,12 +22,19 @@ module Chargehound
 
     # Retrieve a dispute
     # This endpoint will return a single dispute.
-    # @param dispute_id A dispute id
+    # @param [String] dispute_id A dispute id
     # @return [Dispute]
     def self.retrieve(dispute_id)
       ApiRequest.new(:get, "disputes/#{dispute_id}").run
     end
 
+    # Retrieve the response for a dispute.
+    # @param [String] dispute_id A dispute id
+    # @return [Dispute]
+    def self.response(dispute_id)
+      ApiRequest.new(:get, "disputes/#{dispute_id}/response").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
@@ -36,38 +44,20 @@ module Chargehound
     # 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 [Object] :products List of products the customer
-    #   purchased.
-    # @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
+      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 [Object] :products List of products the customer
-    #   purchased.
-    # @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
+      ApiRequest.new(:put, "disputes/#{dispute_id}",
+                     body: update).run
     end
   end
 end

data/lib/chargehound/models.rb

@@ -0,0 +1,45 @@
+require 'ostruct'
+
+module Chargehound
+  # Base class for Chargehound models
+  class ChargehoundObject < OpenStruct
+    def to_json(*a)
+      as_json(*a).to_json
+    end
+
+    def as_json(*_a)
+      hash = {}
+      each_pair do |key, value|
+        hash[key] = convert(value)
+      end
+      hash
+    end
+
+    def convert(value)
+      if value.is_a?(OpenStruct)
+        value.as_json
+      elsif value.is_a?(Array)
+        value.map { |item| convert(item) }
+      elsif value.is_a?(Struct)
+        value.to_h
+      else
+        value
+      end
+    end
+  end
+
+  class Dispute < ChargehoundObject
+  end
+
+  class Response < ChargehoundObject
+  end
+
+  class List < ChargehoundObject
+  end
+
+  class Product < 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 = '1.2.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/test/disputes_test.rb

@@ -13,6 +13,10 @@ post_headers = {
   'User-Agent' => "Chargehound/v1 RubyBindings/#{Chargehound::VERSION}"
 }
 
+dispute_create = {
+  id: 'dp_123'
+}
+
 dispute_update = {
   fields: {
     customer_name: 'Susie'
@@ -44,9 +48,52 @@ dispute_with_product_info_update = {
   ]
 }
 
+dispute_with_product_info_response = {
+  id: 'dp_123',
+  object: 'dispute',
+  fields: {
+    customer_name: 'Susie'
+  },
+  products: [
+    {
+      name:        'Saxophone',
+      description: 'Alto saxophone, with carrying case',
+      image:       'http://s3.amazonaws.com/chargehound/saxophone.png',
+      sku:         '17283001272',
+      quantity:    1,
+      amount:      20_000,
+      url:         'http://www.example.com'
+    }, {
+      name:        'Milk',
+      description: 'Semi-skimmed Organic',
+      image:       'http://s3.amazonaws.com/chargehound/milk.png',
+      sku:         '26377382910',
+      quantity:    '64oz',
+      amount:      400,
+      url:         'http://www.example.com'
+    }
+  ]
+}
+
 dispute_response = {
-  'id' => 'dp_123'
-}.to_json
+  id: 'dp_123',
+  object: 'dispute',
+  products: []
+}
+
+dispute_list_response = {
+  object: 'list',
+  data: [{
+    id: 'dp_123',
+    object: 'dispute',
+    products: []
+  }]
+}
+
+response_response = {
+  dispute_id: 'dp_123',
+  object: 'response'
+}
 
 describe Chargehound::Disputes do
   before do
@@ -57,10 +104,71 @@ describe Chargehound::Disputes do
     WebMock.reset!
   end
 
+  it 'can expose the response status code' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: get_headers)
+           .to_return(body: dispute_list_response.to_json)
+
+    list = Chargehound::Disputes.list
+    assert_requested stub
+    assert_equal('200', list.response.status)
+  end
+
+  it 'uses typed response objects' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: get_headers)
+           .to_return(body: dispute_list_response.to_json)
+
+    list = Chargehound::Disputes.list
+    assert_requested stub
+
+    assert_instance_of(Chargehound::List, list)
+    assert_instance_of(Chargehound::Dispute, list.data[0])
+
+    assert_equal('list', list.object)
+    assert_equal('dp_123', list.data[0].id)
+  end
+
+  it 'typed response objects can be JSON stringified' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: get_headers)
+           .to_return(body: dispute_list_response.to_json)
+
+    list = Chargehound::Disputes.list
+    assert_requested stub
+
+    list_hash = list.as_json
+    list_json = list.to_json
+
+    response = {
+      object: 'list',
+      data: [{
+        id: 'dp_123',
+        object: 'dispute',
+        products: []
+      }],
+      response: {
+        status: '200'
+      }
+    }
+
+    assert_equal(response, list_hash)
+    assert_equal(response.to_json, list_json)
+  end
+
+  it 'can create a dispute' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes')
+           .with(headers: post_headers)
+           .to_return(body: dispute_response.to_json)
+
+    Chargehound::Disputes.create(dispute_create)
+    assert_requested stub
+  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)
+           .to_return(body: dispute_list_response.to_json)
 
     Chargehound::Disputes.list
     assert_requested stub
@@ -69,17 +177,28 @@ describe Chargehound::Disputes do
   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)
+           .to_return(body: dispute_response.to_json)
 
     Chargehound::Disputes.retrieve('dp_123')
     assert_requested stub
   end
 
+  it 'can retrieve a dispute response' do
+    stub = stub_request(:get, 'https://api.chargehound.com/v1/disputes/dp_123/response')
+           .with(headers: get_headers)
+           .to_return(body: response_response.to_json)
+
+    response = Chargehound::Disputes.response('dp_123')
+    assert_instance_of(Chargehound::Response, response)
+    assert_equal('dp_123', response.dispute_id)
+    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,
+           .to_return(body: dispute_response.to_json,
                       status: 201)
 
     Chargehound::Disputes.submit('dp_123', dispute_update)
@@ -90,17 +209,31 @@ describe Chargehound::Disputes do
     stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
            .with(headers: post_headers,
                  body: dispute_with_product_info_update.to_json)
-           .to_return(body: dispute_response,
+           .to_return(body: dispute_with_product_info_response.to_json,
                       status: 201)
 
     Chargehound::Disputes.submit('dp_123', dispute_with_product_info_update)
     assert_requested stub
   end
 
+  it 'has a model for product data' do
+    stub = stub_request(:post, 'https://api.chargehound.com/v1/disputes/dp_123/submit')
+           .with(headers: post_headers,
+                 body: dispute_with_product_info_update.to_json)
+           .to_return(body: dispute_with_product_info_response.to_json,
+                      status: 201)
+
+    dispute = Chargehound::Disputes.submit('dp_123',
+                                           dispute_with_product_info_update)
+
+    assert_instance_of(Chargehound::Product, dispute.products[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)
-           .to_return(body: dispute_response)
+           .to_return(body: dispute_response.to_json)
 
     Chargehound::Disputes.update('dp_123', dispute_update)
     assert_requested stub
@@ -110,7 +243,7 @@ describe Chargehound::Disputes do
     stub = stub_request(:put, 'https://api.chargehound.com/v1/disputes/dp_123')
            .with(headers: post_headers,
                  body: dispute_with_product_info_update.to_json)
-           .to_return(body: dispute_response)
+           .to_return(body: dispute_response.to_json)
 
     Chargehound::Disputes.update('dp_123', dispute_with_product_info_update)
     assert_requested stub

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: chargehound
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chargehound
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - <
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - <
-      - !ruby/object:Gem::Version
-        version: '2.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
@@ -84,14 +70,14 @@ dependencies:
   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
@@ -102,9 +88,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -116,6 +102,7 @@ files:
 - lib/chargehound/api_request.rb
 - lib/chargehound/disputes.rb
 - lib/chargehound/error.rb
+- lib/chargehound/models.rb
 - lib/chargehound/version.rb
 - test/chargehound_test.rb
 - test/disputes_test.rb
@@ -131,17 +118,17 @@ 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Chargehound API