ontraport_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 100d1e11e295ba1f0d131d1242b238ff8903fbcd
+  data.tar.gz: e2fd3068a0f65bafea755d96a617208151f02cf6
+SHA512:
+  metadata.gz: 38f94ba278200b750385c5c7103f74a8845e3b48bd7d7a79496b7b9c8eef5bb0a036c896f7490e4a241be99c17d5dc368f4ec5e76eb7a5b605c1c1a1686c5990
+  data.tar.gz: eb9e121e18c1bf6da429812dd3acf203bac6628f2f16b360448654089b5baac4d3374a864103741d412ee2fff8c048f50c50140b2141113d30d6b9eefccf955f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jimmy Ngu
+
+MIT License
+
+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,110 @@
+# OntraportApi
+
+[![Gem Version](https://badge.fury.io/rb/ontraport_api.svg)](http://badge.fury.io/rb/ontraport_api)
+
+A Ruby Client for Ontraport's REST JSON API 
+
+https://api.ontraport.com/doc/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ontraport_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ontraport_api
+
+## Usage
+
+Basic example: 
+
+```ruby
+require 'ontraport_api'
+
+client = OntraportApi::Client.new('app-id','app-key')
+
+search_results = client.get_contacts({ condition: "email = 'me@jimmyngu.com'" })
+puts search_results['data']
+
+# Error handling
+puts search_results['error']    # true if error
+puts search_results['message']  # API response body when error
+```
+
+## Supported APIs
+
+### Contacts
+
+```ruby
+client.get_contact(id)                                        # Get a Contact's Data
+client.new_contact(contact_params)                            # Create new Contact
+client.update_contact(id, contact_params)                     # Update Contact Details
+client.contact_fields(format)                                 # Fetch Contact Meta Fields
+client.add_tags_to_contacts(tag_ids, contacts_criteria)       # Add Tags to Selected Contacts
+client.remove_tags_from_contacts(tag_ids, contacts_criteria)  # Remove Tags from Selected Contacts
+client.get_contacts(search_criteria)                          # Get List of Contacts based on Search Criteria
+client.get_contacts_by_<field_name>(value)                    # Wildcard alias to client.get_contacts("<field_name> = 'value'")
+```
+
+### Tags (experimental)
+
+```ruby
+client.get_tags(conditions)                 # Get Tags by condition
+client.new_tag(tag_name)                    # Create new Tag with tag_name
+client.get_tags_by_<field_name>(value)      # Wildcard alias to client.get_tags("<field_name> = 'value'")
+```
+
+### Sequences (experimental)
+
+```ruby
+client.get_sequences(conditions)                # Get all sequences
+client.get_sequences_by_<field_name>(value)     # Wildcard alias to client.get_sequences("<field_name> = 'value'")
+```
+
+See https://api.ontraport.com/doc/ on details of parameters.
+
+## Contributing
+
+1. Fork it ( https://github.com/jimmynguyc/ontraport_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## TODO Lists
+
+- Forms API
+- Transactions API
+- Messages API
+- Tasks API
+- Products API
+
+
+## Experimental / Missing Endpoints
+
+Many element endpoints are experimental since the JSON API is so new and documentation is lacking in general. I'm working with the "objects" API endpoint mostly for those. Will update as they become available.
+
+Otherwise, they're missing because I haven't got to them yet. Check the TODO list and let me know if I've missed anything.
+
+
+## Release Notes
+
+#### v0.0.4
+- Add Tags API
+- Wildcard field_name search
+- Error handling with error message hash
+
+#### v0.0.3
+- Add Sequences API
+
+#### v0.0.1
+- Contacts API

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*/*_test.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/lib/ontraport_api/apis/contacts.rb

@@ -0,0 +1,73 @@
+module OntraportApi
+  module APIs
+    module Contacts
+      CONTACTS_OBJECT_ID = 0
+      CONTACTS_API_METHODS_AND_PATHS = {
+        'get_contact'                 => [:get,     '/object'],
+        'new_contact'                 => [:post,    '/objects'],
+        'update_contact'              => [:put,     '/objects'],
+        'get_contacts'                => [:get,     '/objects'],
+        'contact_fields'              => [:get,     '/objects/meta'],
+        'add_tags_to_contacts'        => [:put,     '/objects/tag'],
+        'remove_tags_from_contacts'   => [:delete,  '/objects/tag']
+      }
+
+      def get_contact(id)
+        query_contacts({id: id})
+      end
+
+      def new_contact(payload = {})
+        query_contacts(payload)
+      end
+
+      def update_contact(id, payload = {})
+        query_contacts(payload.merge(id: id))
+      end
+
+      def contact_fields(format = {})
+        default_format = { format: 'byId' }
+        format = default_format.merge(format)
+        query_contacts(format)
+      end
+
+      def add_tags_to_contacts(tag_ids, conditions = {})
+        conditions = { condition: conditions } if conditions.is_a? String
+        default_conditions = {
+          performAll: true
+        }
+        conditions = default_conditions.merge(conditions)
+
+        tag_ids = tag_ids.is_a?(Array) ? tag_ids.join(',') : tag_ids
+        query_contacts(conditions.merge({ add_list: tag_ids }))
+      end
+
+      def remove_tags_from_contacts(tag_ids, conditions = {})
+        conditions = { condition: conditions } if conditions.is_a? String
+        default_conditions = {
+          performAll: true
+        }
+        conditions = default_conditions.merge(conditions)
+
+        tag_ids = tag_ids.is_a?(Array) ? tag_ids.join(',') : tag_ids
+        query_contacts(conditions.merge({ remove_list: tag_ids }))
+      end
+
+      def get_contacts(conditions = {})
+        conditions = { condition: conditions } if conditions.is_a? String
+        default_conditions = {
+          performAll: true,
+          sortDir: 'asc',
+          searchNotes: 'true'
+        }
+        payload = default_conditions.merge(conditions)
+        query_contacts(payload)
+      end
+
+      def query_contacts(payload)
+        method, path = CONTACTS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload.merge({ objectID: CONTACTS_OBJECT_ID }))
+      end
+
+    end
+  end
+end

data/lib/ontraport_api/apis/forms.rb

@@ -0,0 +1,18 @@
+module OntraportApi
+  module APIs
+    module Forms
+      FORMS_API_METHODS_AND_PATHS = {
+        'get_form'     => [:get,     '/form']
+      }
+
+      def get_form(id)
+        query_forms({id: id})
+      end
+
+      def query_forms(payload)
+        method, path = FORMS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload)
+      end
+    end
+  end
+end

data/lib/ontraport_api/apis/messages.rb

@@ -0,0 +1,18 @@
+module OntraportApi
+  module APIs
+    module Messages
+      MESSAGES_API_METHODS_AND_PATHS = {
+        'get_message'     => [:get,     '/message']
+      }
+
+      def get_message(id)
+        query_messages({id: id})
+      end
+
+      def query_messages(payload)
+        method, path = MESSAGES_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload)
+      end
+    end
+  end
+end

data/lib/ontraport_api/apis/products.rb

@@ -0,0 +1,6 @@
+module OntraportApi
+  module APIs
+    module Products
+    end
+  end
+end

data/lib/ontraport_api/apis/sequences.rb

@@ -0,0 +1,19 @@
+module OntraportApi
+  module APIs
+    module Sequences
+      SEQUENCES_OBJECT_ID = 5
+      SEQUENCES_API_METHODS_AND_PATHS = {
+        'get_sequences'     => [:get,     '/objects']
+      }
+
+      def get_sequences(condition = '')
+        query_sequences({ condition: condition })
+      end
+
+      def query_sequences(payload = {})
+        method, path = SEQUENCES_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload.merge({ objectID: SEQUENCES_OBJECT_ID }))
+      end
+    end
+  end
+end

data/lib/ontraport_api/apis/tags.rb

@@ -0,0 +1,24 @@
+module OntraportApi
+  module APIs
+    module Tags
+      TAGS_OBJECT_ID = 14
+      TAGS_API_METHODS_AND_PATHS = {
+        'get_tags'     => [:get,     '/objects'],
+        'new_tag'     => [:post,    '/objects'],
+      }
+
+      def get_tags(condition = '')
+        query_tags({ condition: condition })
+      end
+
+      def new_tag(tag_name)
+        query_tags({ tag_name: tag_name })
+      end
+
+      def query_tags(payload = {})
+        method, path = TAGS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload.merge({ objectID: TAGS_OBJECT_ID }))
+      end
+    end
+  end
+end

data/lib/ontraport_api/apis/tasks.rb

@@ -0,0 +1,23 @@
+module OntraportApi
+  module APIs
+    module Tasks
+      TASKS_API_METHODS_AND_PATHS = {
+        'cancel_task'     => [:post,     '/task/cancel'],
+        'complete_task'   => [:post,     '/task/complete']
+      }
+
+      def cancel_task(criteria = {})
+        query_tasks(criteria)
+      end
+
+      def complete_task(criteria = {}, data = {})
+        query_tasks({ criteria: criteria, data: data })
+      end
+
+      def query_tasks(payload)
+        method, path = TASKS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload)
+      end
+    end
+  end
+end

data/lib/ontraport_api/apis/transactions.rb

@@ -0,0 +1,78 @@
+module OntraportApi
+  module APIs
+    module Transactions
+      TRANSACTIONS_API_METHODS_AND_PATHS = {
+        'new_transaction'                     => [:post, '/transaction/processManual'],
+        'refund_transactions'                 => [:put,  '/transaction/refund'],
+        'convert_transactions_to_decline'     => [:put,  '/transaction/convertToDecline'],
+        'convert_transactions_to_collections' => [:put,  '/transaction/convertToCollections'],
+        'void_transaction'                    => [:put,  '/transaction/void'],
+        'void_purchase'                       => [:put,  '/transaction/voidPurchase'],
+        'rerun_commission'                    => [:put,  '/transaction/rerunCommission'],
+        'mark_paid'                           => [:put,  '/transaction/markPaid'],
+        'rerun_transaction'                   => [:post, '/transaction/rerun'],
+        'write_off_transaction'               => [:put,  '/transaction/writeOff'],
+        'get_order'                           => [:get,  '/transaction/order'],
+        'update_order'                        => [:put,  '/transaction/order'],
+        'resend_invoice'                      => [:post, '/transaction/resendInvoice']
+      }
+
+      def new_transaction(transaction = {})
+        query_transactions(transaction)
+      end
+
+      def refund_transactions(criteria = {})
+        query_transactions(criteria)
+      end
+
+      def convert_transactions_to_decline(id)
+        query_transactions({ id: id })
+      end
+
+      def convert_transactions_to_collections(id)
+        query_transactions({ id: id })
+      end
+
+      def void_transaction(criteria = {})
+        query_transactions(criteria)
+      end
+
+      def void_purchase(id)
+        query_transactions({ id: id })
+      end
+
+      def rerun_commission(criteria = {})
+        query_transactions(criteria)
+      end
+
+      def mark_paid(id)
+        query_transactions({ id: id })
+      end
+
+      def rerun_transaction(criteria = {})
+        query_transactions(criteria)
+      end
+
+      def write_off_transaction(id)
+        query_transactions({ id: id })
+      end
+
+      def get_order(id)
+        query_transactions({ id: id })
+      end
+
+      def update_order(payload = {})
+        query_transactions(payload)
+      end
+
+      def resend_invoice(payload = {})
+        query_transactions(payload)
+      end
+
+      def query_transactions(payload)
+        method, path = TRANSACTIONS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload)
+      end
+    end
+  end
+end

data/lib/ontraport_api/client.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+require_relative 'apis/contacts'
+require_relative 'apis/forms'
+require_relative 'apis/messages'
+require_relative 'apis/products'
+require_relative 'apis/sequences'
+require_relative 'apis/tags'
+require_relative 'apis/tasks'
+require_relative 'apis/transactions'
+
+module OntraportApi
+  class Client
+    include HTTParty
+    base_uri 'https://api.ontraport.com/1'
+
+    include APIs::Contacts
+    include APIs::Products
+    include APIs::Forms
+    include APIs::Messages
+    include APIs::Products
+    include APIs::Sequences
+    include APIs::Tags
+    include APIs::Tasks
+    include APIs::Transactions
+
+    class InvalidAppIdOrApiKey < StandardError
+      def to_s
+        "APP ID and API Key must not be blank"
+      end
+    end
+
+    class InvalidAPIMethodOrPath < StandardError
+      def to_s
+        "Invalid API Method or Path"
+      end
+    end
+
+    def initialize(app_id, api_key)
+      raise InvalidAppIdOrApiKey if [app_id, api_key].any? { |w| w !~ blank_regex }
+      @app_id = app_id
+      @api_key = api_key
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^get_[\w]+_by_[\w]+/
+        match, subject, keyword = method.to_s.match(/^get_(\w+)_by_(\w+)/).to_a
+
+        if !respond_to?("get_#{subject}".to_sym) || [subject, keyword].any? { |w| w !~ blank_regex }
+          return super
+        end
+
+        self.send("get_#{subject}", "#{keyword} = '#{args[0]}'")
+      else
+        super
+      end
+    end
+
+    private
+
+    def query(method, path, payload = {})
+      raise InvalidAPIMethodOrPath if [method, path].any? { |w| w !~ blank_regex } || ![:get, :post, :put, :delete].include?(method)
+      response = self.class.send(method, path, query: payload, body: payload, headers: api_credentials_headers )
+      response.parsed_response
+    rescue JSON::ParserError => e
+      {
+        'error'   => true,
+        'message' => response.body
+      }
+    end
+
+    def api_credentials_headers
+      { 'Api-Appid' => @app_id, 'Api-Key' => @api_key }
+    end
+
+    def blank_regex
+      /[^[:space:]]/
+    end
+
+  end
+end

data/lib/ontraport_api/version.rb

@@ -0,0 +1,3 @@
+module OntraportApi
+  VERSION = "0.1.0"
+end

data/lib/ontraport_api.rb

@@ -0,0 +1,2 @@
+require 'ontraport_api/version'
+require 'ontraport_api/client'

data/objectids.txt

@@ -0,0 +1,31 @@
+0 - contacts
+1 - ?
+2 - Users
+3 - ?
+4 - ?
+5 - Sequences
+6 - ?
+7 - Messages
+8 - ?
+9 - Sequences Steps
+10 - ?
+11 - ?
+12 - ?
+13 - ?
+14 - Tags
+15 - ?
+16 - Products
+17 - ?
+18 - ?
+19 - ?
+20 - ?
+21 - 404
+22 - ?
+23 - ?
+24 - ?
+25 - ?
+26 - ?
+27 - ?
+28 - ?
+29 - ?
+30 - ?

data/ontraport_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ontraport_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ontraport_api'
+  spec.version       = OntraportApi::VERSION
+  spec.authors       = ['Jimmy Ngu']
+  spec.email         = ['jimmynguyc@gmail.com']
+  spec.summary       = %q{Ruby Client for Ontraport's JSON API}
+  spec.description   = %q{Ruby client for Ontraport's JSON API}
+  spec.homepage      = 'https://github.com/jimmynguyc/ontraport_api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency "minitest", '~> 5.6'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+end

data/test/ontraport_api/client_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+require 'ontraport_api/client'
+
+describe OntraportApi::Client do
+
+  describe 'Error handling' do
+    it 'when app_id or api_key blank' do
+      proc {
+        OntraportApi::Client.new(nil, nil)
+      }.must_raise OntraportApi::Client::InvalidAppIdOrApiKey
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ontraport_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Ngu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Ruby client for Ontraport's JSON API
+email:
+- jimmynguyc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ontraport_api.rb
+- lib/ontraport_api/apis/contacts.rb
+- lib/ontraport_api/apis/forms.rb
+- lib/ontraport_api/apis/messages.rb
+- lib/ontraport_api/apis/products.rb
+- lib/ontraport_api/apis/sequences.rb
+- lib/ontraport_api/apis/tags.rb
+- lib/ontraport_api/apis/tasks.rb
+- lib/ontraport_api/apis/transactions.rb
+- lib/ontraport_api/client.rb
+- lib/ontraport_api/version.rb
+- objectids.txt
+- ontraport_api.gemspec
+- test/ontraport_api/client_test.rb
+- test/test_helper.rb
+homepage: https://github.com/jimmynguyc/ontraport_api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Client for Ontraport's JSON API
+test_files:
+- test/ontraport_api/client_test.rb
+- test/test_helper.rb