omise 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff392328416601e36ba46368afcbb591eeb811b
-  data.tar.gz: e3317b3b98779651c2cfc7bd99621500f57a101d
+  metadata.gz: fb0747d2916db26b8867f729d2fc45ec8c0ae298
+  data.tar.gz: 6f32be4761236faaca1495948d8bd4abe33581c0
 SHA512:
-  metadata.gz: 61bb3e5a0bfac06e1c930bb78d0e2cf89e07453e8ed1911a8874197d7152e69975457d9e923c2984b92e2a01f44a14180ec9f03707f5495120c585912aab2227
-  data.tar.gz: d5e4f4475e8cc0fc395d2c747206cbb60e569dd3dc8cceb11b3f3478eb9f00e82431197062a4e7d2dbacd3f90e1e1c2aacf8112194dc067a4b3de73441c54856
+  metadata.gz: 5f0cdda6e658f79be9a7056e2f49d5a634cb8cb74664b2e54753bce1d36ff8c6e3120e5c4f69536dac1ed4fb9d0124516e2c8ba838a50a0351beaa16ea1458d6
+  data.tar.gz: 6fbba84db39bfe3efbf8085b82c2c32931d913745b972299e8d4560a86abbab9f02c82cab48e70f4dfbaa878e18274b0c58e88bf1254d1a9069782c6981eeed3

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 An [unreleased] version is not available on rubygems and is subject to changes and must not be considered final. Elements of unreleased list may be edited or removed at any time.
 
+## [0.5.0] 2016-11-26
+
+- [Added] Add search object and filtering api
+- [Added] Add support for document uploading
+- [Added] Add link API
+- [Added] Add tests for attributes
+- [Added] Add charge method on customer
+- [Added] Add pagination on list
+
 ## [0.4.0] 2016-06-01
 
 - [Added] Add charge reversal method (@zentetsukenz)

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omise"
+
+Omise.api_key = ENV["OMISE_API_KEY"]
+
+require "pry"
+Pry.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/omise/all.rb

@@ -4,9 +4,12 @@ require "omise/card"
 require "omise/charge"
 require "omise/customer"
 require "omise/dispute"
+require "omise/document"
 require "omise/event"
+require "omise/link"
 require "omise/recipient"
 require "omise/refund"
+require "omise/search"
 require "omise/token"
 require "omise/transaction"
 require "omise/transfer"

data/lib/omise/attributes.rb

@@ -2,9 +2,10 @@ require "omise/util"
 
 module Omise
   module Attributes
-    def initialize(attributes = {})
+    def initialize(attributes = {}, options = {})
+      @attributes          = attributes
+      @options             = options
       @expanded_attributes = {}
-      @attributes = attributes
     end
 
     def attributes
@@ -62,7 +63,15 @@ module Omise
     end
 
     def list_attribute(klass, key)
-      klass.new(self, @attributes[key])
+      klass.new(@attributes[key], parent: self)
+    end
+
+    def list_nested_resource(klass, key, options = {})
+      if @attributes.key?(key) && options.empty?
+        return list_attribute(klass, key)
+      end
+
+      klass.new(nested_resource(key, options).get, parent: self)
     end
 
     def expand_attribute(object, key, options = {})

data/lib/omise/card_list.rb

@@ -4,18 +4,13 @@ require "omise/token"
 
 module Omise
   class CardList < List
-    def initialize(customer, attributes = {})
-      super(attributes)
-      @customer = customer
-    end
-
     def retrieve(id, attributes = {})
       Card.new self.class.resource(location(id), attributes).get(attributes)
     end
 
     def create(attributes = {})
       token = Token.create(card: attributes)
-      @customer.update(card: token.id)
+      parent.update(card: token.id)
       retrieve(token.card.id)
     end
   end

data/lib/omise/charge.rb

@@ -3,12 +3,17 @@ require "omise/list"
 require "omise/customer"
 require "omise/dispute"
 require "omise/refund_list"
+require "omise/search_scope"
 require "omise/transaction"
 
 module Omise
   class Charge < OmiseObject
     self.endpoint = "/charges"
 
+    def self.search
+      SearchScope.new(:charge)
+    end
+
     def self.retrieve(id, attributes = {})
       new resource(location(id), attributes).get(attributes)
     end

data/lib/omise/charge_list.rb

@@ -0,0 +1,10 @@
+require "omise/list"
+require "omise/charge"
+
+module Omise
+  class ChargeList < List
+    def retrieve(id, attributes = {})
+      Charge.retrieve(id)
+    end
+  end
+end

data/lib/omise/customer.rb

@@ -1,11 +1,17 @@
 require "omise/object"
-require "omise/list"
 require "omise/card_list"
+require "omise/charge"
+require "omise/list"
+require "omise/search_scope"
 
 module Omise
   class Customer < OmiseObject
     self.endpoint = "/customers"
 
+    def self.search
+      SearchScope.new(:customer)
+    end
+
     def self.retrieve(id = nil, attributes = {})
       new resource(location(id), attributes).get(attributes)
     end
@@ -30,6 +36,10 @@ module Omise
       assign_attributes resource(attributes).delete
     end
 
+    def charge(attributes = {})
+      Charge.create(attributes.merge(customer: id))
+    end
+
     def default_card(options = {})
       expand_attribute cards, "default_card", options
     end
@@ -39,7 +49,7 @@ module Omise
         list_attribute CardList, "cards"
       else
         response = collection.resource(location("cards")).get(options)
-        CardList.new(self, response)
+        CardList.new(response, parent: self)
       end
     end
   end

data/lib/omise/dispute.rb

@@ -1,11 +1,17 @@
 require "omise/object"
 require "omise/charge"
+require "omise/document_list"
 require "omise/list"
+require "omise/search_scope"
 
 module Omise
   class Dispute < OmiseObject
     self.endpoint = "/disputes"
 
+    def self.search
+      SearchScope.new(:dispute)
+    end
+
     def self.list(attributes = {})
       status = attributes.delete(:status)
       List.new resource(location(status), attributes).get(attributes)
@@ -26,5 +32,9 @@ module Omise
     def charge(options = {})
       expand_attribute Charge, "charge", options
     end
+
+    def documents(options = {})
+      list_nested_resource DocumentList, "documents", options
+    end
   end
 end

data/lib/omise/document.rb

@@ -0,0 +1,15 @@
+require "omise/object"
+
+module Omise
+  class Document < OmiseObject
+    self.endpoint = "/documents"
+
+    def reload(attributes = {})
+      assign_attributes resource(attributes).get(attributes)
+    end
+
+    def destroy(attributes = {})
+      assign_attributes resource(attributes).delete
+    end
+  end
+end

data/lib/omise/document_list.rb

@@ -0,0 +1,15 @@
+require "omise/document"
+require "omise/list"
+
+module Omise
+  class DocumentList < List
+    def retrieve(id, attributes = {})
+      Document.new self.class.resource(location(id), attributes).get(attributes)
+    end
+
+    def upload(file)
+      attributes = { file: file }
+      Document.new self.class.resource(location, attributes).post(attributes)
+    end
+  end
+end

data/lib/omise/error.rb

@@ -1,12 +1,10 @@
 module Omise
   class Error < StandardError
-    def initialize(attributes = {})
+    def initialize(attributes)
       @code = attributes["code"]
-      @message = attributes["message"]
+      super("#{attributes["message"]} (#{@code})")
     end
 
-    def to_s
-      "#{@message} (#{@code})"
-    end
+    attr_reader :code
   end
 end

data/lib/omise/link.rb

@@ -0,0 +1,37 @@
+require "omise/object"
+require "omise/charge_list"
+
+module Omise
+  class Link < OmiseObject
+    self.endpoint = "/links"
+
+    def self.search
+      SearchScope.new(:link)
+    end
+
+    def self.retrieve(id, attributes = {})
+      new resource(location(id), attributes).get(attributes)
+    end
+
+    def self.list(attributes = {})
+      List.new resource(location, attributes).get(attributes)
+    end
+
+    def self.create(attributes = {})
+      new resource(location, attributes).post(attributes)
+    end
+
+    def reload(attributes = {})
+      assign_attributes resource(attributes).get(attributes)
+    end
+
+    def charges(options = {})
+      if options.empty?
+        list_attribute ChargeList, "charges"
+      else
+        response = collection.resource(location("charges")).get(options)
+        ChargeList.new(self, response)
+      end
+    end
+  end
+end

data/lib/omise/list.rb

@@ -5,8 +5,8 @@ module Omise
   class List < OmiseObject
     include Enumerable
 
-    def initialize(attributes = {})
-      super(attributes)
+    def initialize(attributes = {}, options = {})
+      super(attributes, options)
       setup_data
     end
 
@@ -16,6 +16,38 @@ module Omise
       end
     end
 
+    def parent
+      @options[:parent]
+    end
+
+    def first_page?
+      offset == 0
+    end
+
+    def last_page?
+      offset + limit >= total
+    end
+
+    def page
+      1 + (offset / limit)
+    end
+
+    def total_pages
+      (total.to_f / limit).ceil
+    end
+
+    def next_page
+      self.class.new(@attributes, @options).send(:next_page!)
+    end
+
+    def previous_page
+      self.class.new(@attributes, @options).send(:previous_page!)
+    end
+
+    def jump_to_page(page)
+      self.class.new(@attributes, @options).send(:jump_to_page!, page)
+    end
+
     def each(*args, &block)
       to_a.each(*args, &block)
     end
@@ -30,6 +62,25 @@ module Omise
 
     private
 
+    def jump_to_page!(page)
+      new_offset = ((page - 1) * limit)
+      return nil if new_offset >= total
+      reload(offset: new_offset, limit: limit)
+      self
+    end
+
+    def next_page!
+      return nil if (offset + limit) >= total
+      reload(offset: offset + limit, limit: limit)
+      self
+    end
+
+    def previous_page!
+      return nil if (offset - limit) < 0
+      reload(offset: offset - limit, limit: limit)
+      self
+    end
+
     def setup_data
       @data = @attributes["data"].map { |o| Omise::Util.typecast(o) }
     end

data/lib/omise/recipient.rb

@@ -1,10 +1,15 @@
 require "omise/object"
 require "omise/bank_account"
+require "omise/search_scope"
 
 module Omise
   class Recipient < OmiseObject
     self.endpoint = "/recipients"
 
+    def self.search
+      SearchScope.new(:recipient)
+    end
+
     def self.retrieve(id, attributes = {})
       new resource(location(id), attributes).get(attributes)
     end

data/lib/omise/refund.rb

@@ -6,6 +6,10 @@ module Omise
   class Refund < OmiseObject
     self.endpoint = "/refunds"
 
+    def self.search
+      SearchScope.new(:refund)
+    end
+
     def reload(attributes = {})
       assign_attributes resource(attributes).get(attributes)
     end

data/lib/omise/refund_list.rb

@@ -3,11 +3,6 @@ require "omise/refund"
 
 module Omise
   class RefundList < List
-    def initialize(charge, attributes = {})
-      super(attributes)
-      @charge = charge
-    end
-
     def create(attributes = {})
       Refund.new self.class.resource(location, attributes).post(attributes)
     end

data/lib/omise/resource.rb

@@ -12,26 +12,26 @@ module Omise
   class Resource
     CA_BUNDLE_PATH = File.expand_path("../../../data/ca_certificates.pem", __FILE__)
     DEFAULT_HEADERS = {
-      user_agent: "OmiseRuby/#{Omise::VERSION} Ruby/#{RUBY_VERSION}"
+      user_agent: "OmiseRuby/#{Omise::VERSION} Ruby/#{RUBY_VERSION}",
     }
 
     def initialize(url, path, key)
-      @uri = prepare_uri(url, path)
+      @uri     = prepare_uri(url, path)
       @headers = prepare_headers
-      @key = key
+      @key     = key
 
-      @resource = RestClient::Resource.new(@uri, {
-        user: key,
-        verify_ssl: OpenSSL::SSL::VERIFY_PEER,
-        ssl_ca_file: CA_BUNDLE_PATH,
-        headers: @headers,
-      })
+      set_resource
     end
 
     attr_reader :uri, :headers, :key
 
     def get(attributes = {})
-      @resource.get(params: attributes) { |r| Omise::Util.load_response(r) }
+      if attributes.any?
+        @uri.query = Omise::Util.generate_query(attributes)
+        set_resource
+      end
+
+      @resource.get { |r| Omise::Util.load_response(r) }
     end
 
     def patch(attributes = {})
@@ -48,10 +48,24 @@ module Omise
 
     private
 
+    def set_resource
+      @resource = RestClient::Resource.new(@uri.to_s, {
+        user: @key,
+        verify_ssl: OpenSSL::SSL::VERIFY_PEER,
+        ssl_ca_file: CA_BUNDLE_PATH,
+        headers: @headers,
+      })
+    end
+
     def prepare_uri(url, path)
-      uri = URI.parse(url)
-      uri.path = [uri.path, path].join
-      uri.to_s
+      URI.parse(url).tap do |uri|
+        path  = URI.parse(path)
+        query = path.query
+
+        path.query = nil
+        uri.path   = [uri.path, path.to_s].join
+        uri.query  = query
+      end
     end
 
     def prepare_headers