v. 0.1.2 - support of Objects 'create' method and more

hamzatayeb · hamzatayeb · commit fc6aa1b88681 · 2016-04-14T09:36:24.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+# Unreleased
+
+# 0.1.2 - April 14, 2016
+
+- Add support for Objects `create` method
+- Better formatting for `APIError` exceptions
+- Add Transactions `get_order` method
+
 # 0.1.1 - February 6, 2016
 
 - Update documentation
diff --git a/lib/ontraport.rb b/lib/ontraport.rb
@@ -44,7 +44,7 @@ def self.clear_describe_cache!
     @objects_meta_cache = nil
   end
 
-  # @!group Accessor methods
+  # @!group "Objects" Methods
 
   # Retrieve a single object of the specified type.
   # 
@@ -74,8 +74,20 @@ def self.get_objects object_type, params={}
     objects_call :get, object_type, endpoint: '/objects', data: params
   end
 
-  # @!endgroup
-  # @!group Modifier methods
+  # Create an object with the given data
+  #
+  # @example
+  #   Ontraport.create :contact, { email: 'foo@bar.com', firstname: 'Foo' }
+  #   #=> #<Ontraport::Response @data=...>
+  #
+  # @see https://api.ontraport.com/doc/#!/objects/createObject API docs
+  #
+  # @param object_type [Symbol] the type of object
+  # @param params [Hash] input data
+  # @return [Response]
+  def self.create object_type, params
+    objects_call :post, object_type, endpoint: '/objects', data: params
+  end
 
   # Create an object with the given data, or merge if the unique field matches another row.
   # 
@@ -139,6 +151,19 @@ def self.untag_objects object_type, object:, tag:
     objects_call :delete, object_type, endpoint: '/objects/tag', data: params
   end
 
+  # @!endgroup
+  # @!group "Transactions" Methods
+
+  # Get full information about an order
+  #
+  # @see https://api.ontraport.com/doc/#!/transactions/getOrder API docs
+  #
+  # @param order_id [Integer] Id of the order
+  # @return [Response]
+  def self.get_order order_id
+    request_with_authentication :get, endpoint: '/transaction/order', data: { id: order_id }
+  end
+
   # @!endgroup
 
   private
@@ -154,7 +179,8 @@ def self.request_with_authentication method, endpoint:, data: nil
       response = HTTParty.send *args, **kwargs
 
       unless response.code.eql? 200
-        raise APIError.new response.body
+        error = "#{response.code} #{response.msg}"
+        raise APIError.new(response.body.present? ? "#{error} - #{response.body}" : error)
       end
 
       Response.new **response.parsed_response.symbolize_keys
diff --git a/lib/ontraport/version.rb b/lib/ontraport/version.rb
@@ -1,3 +1,3 @@
 module Ontraport
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end
diff --git a/ontraport.gemspec b/ontraport.gemspec
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.files                 = Dir.glob("{lib}/**/*") + s.extra_rdoc_files
   s.homepage              = 'https://github.com/hamzatayeb/ontraport-ruby'
   s.license               = 'MIT'
-  s.required_ruby_version = '~> 2.1.8'
+  s.required_ruby_version = '~> 2'
   s.add_dependency 'httparty', ['~> 0.13']
 end
