ontraport_api 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09c473e460cc3c2705a8035e0481535a7f7138c3
-  data.tar.gz: af3a6c1f4815d4f2fdd33a5a8e949b4b6593123c
+  metadata.gz: a97839aad56c249eb9661a4ee7f65adc278de476
+  data.tar.gz: 2d4062e746e2874c17707e0e6a43ca81610629bc
 SHA512:
-  metadata.gz: 973865d6d5bf7e2de3b4a873e22011368739ae9d0b98fc228728d639b87577472dfc86e2a205919de794ea4d1c0184cda4065c1c418f7a1e0a95be9b314a92e6
-  data.tar.gz: 1e74c9a5152ec047639906dc2279f1351762ea15ee4a97670ae09cd843c6f56e9fb13f3d86b5e1ced70eeceaa1e3a04cdcf898e1e8ea5b2203f5f2c36017eb12
+  metadata.gz: 9b5af05ad83b261edf5c501b179c887062910f8735c1eadc4ad67ce61d4959cc605e207f0a558145e49f22ffc385a7e30e41589818cf7e241ef15d53f481621d
+  data.tar.gz: 281a1d41909463b532310537777e39fc1572bbf5660d5931c6e506062b6cd7775d9d5b0eb72f62949604f7eac47577a75939f2231bdadedb5d40d3ba147cd352

data/README.md

@@ -22,25 +22,18 @@ Or install it yourself as:
 
     $ gem install ontraport_api
 
-## Usage
-
-Basic example: 
 
-```ruby
-require 'ontraport_api'
-
-client = OntraportApi::Client.new('app-id','app-key')
+## Supported APIs
 
-search_results = client.get_contacts({ condition: "email = 'me@jimmyngu.com'" })
-puts search_results['data']
+### Objects
 
-# Error handling
-puts search_results['error']    # true if error
-puts search_results['message']  # API response body when error
+```ruby
+client.get_object(id, object_id)                              # Get an Object's Data
+client.new_object(object_params, object_id)                   # Create new Object
+client.update_object(id, object_params, object_id)            # Update Object Details
+client.get_objects(search_criteria, object_id)                # Get List of Objects based on Search Criteria
 ```
 
-## Supported APIs
-
 ### Contacts
 
 ```ruby
@@ -77,6 +70,66 @@ client.add_sequence_to_contact(sequence_drip_id, contact_id)    # Add Sequence t
 
 See https://api.ontraport.com/doc/ on details of parameters.
 
+
+## Usage
+
+Basic example: 
+
+```ruby
+require 'ontraport_api'
+
+client = OntraportApi::Client.new('app-id','app-key')
+
+search_results = client.get_contacts("email = 'me@jimmyngu.com' AND lastname = 'Ngu'")
+puts search_results
+
+# Error handling
+puts search_results['error']    # true if error
+puts search_results['message']  # API response body when error
+```
+
+Finding Contacts:
+
+```ruby
+contact = client.get_contacts_by_email('me@jimmyngu.com').first
+contact = client.get_contacts_by_city('Kuala Lumpur').first
+contact = client.get_contacts_by_sms_number('+60123456789').first
+```
+
+Create New Contact:
+
+```ruby
+contact = client.new_contact({ firstname: 'Jimmy', lastname: 'Ngu', email: 'me@jimmyngu.com' })
+puts 'Success' if contact['error'].nil?
+```
+
+Adding Tags to Contacts:
+
+```ruby
+tag_name = 'Customer'
+tag = client.get_tags_by_tag_name(tag_name).first
+if tag.nil?
+    tag = client.new_tag(tag_name)
+end
+
+result = client.add_tags_to_contacts(tag['tag_id'], { ids: contact['id'] })
+puts 'Success' if result['error'].nil?
+
+# Multiple tags & contacts
+client.add_tags_to_contacts('<tag_id_1>,<tag_id_2>,<tag_id_3>', { ids: '<contact_id_1>,<contact_id_2>,<contact_id_3>' })
+
+# Tag contacts with conditions
+client.add_tags_to_contacts('<tag_id>', "city = 'Kuala Lumpur'" )
+```
+
+Adding Sequence to Contact:
+
+```ruby
+sequence = client.get_sequences_by_name('Sales Funnel')
+result = client.add_sequence_to_contact(sequence['drip_id'], contact['id'])
+puts 'Success' if result['error'].nil?
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/jimmynguyc/ontraport_api/fork )
@@ -104,6 +157,12 @@ Otherwise, they're missing because I haven't got to them yet. Check the TODO lis
 
 ## Release Notes
 
+#### v0.2.2
+- Added generic Object query
+
+#### v0.2.0
+- Return ['data'] as default (breaking v0.1 implementations with ['data'])
+
 #### v0.1.1
 - Add Contact Sequence API
 

data/lib/ontraport_api/apis/objects.rb

@@ -0,0 +1,41 @@
+module OntraportApi
+  module APIs
+    module Objects
+      OBJECTS_API_METHODS_AND_PATHS = {
+        'get_object'                 => [:get,     '/object'],
+        'new_object'                 => [:post,    '/objects'],
+        'update_object'              => [:put,     '/objects'],
+        'get_objects'                => [:get,     '/objects']
+      }
+
+      def get_object(id, object_id)
+        query_objects({id: id}, object_id)
+      end
+
+      def new_object(payload = {}, object_id)
+        query_objects(payload, object_id)
+      end
+
+      def update_object(id, payload = {}, object_id)
+        query_objects(payload.merge(id: id), object_id)
+      end
+
+      def get_objects(conditions = {}, object_id)
+        conditions = { condition: conditions } if conditions.is_a? String
+        default_conditions = {
+          performAll: true,
+          sortDir: 'asc',
+          searchNotes: 'true'
+        }
+        payload = default_conditions.merge(conditions)
+        query_objects(payload, object_id)
+      end
+
+      def query_objects(payload, object_id)
+        method, path = OBJECTS_API_METHODS_AND_PATHS[caller[0][/`.*'/][1..-2]]
+        query(method, path, payload.merge({ objectID: object_id }))
+      end
+
+    end
+  end
+end

data/lib/ontraport_api/client.rb

@@ -3,6 +3,7 @@ require_relative 'apis/contacts'
 require_relative 'apis/contact_sequences'
 require_relative 'apis/forms'
 require_relative 'apis/messages'
+require_relative 'apis/objects'
 require_relative 'apis/products'
 require_relative 'apis/sequences'
 require_relative 'apis/tags'
@@ -19,6 +20,7 @@ module OntraportApi
     include APIs::Products
     include APIs::Forms
     include APIs::Messages
+    include APIs::Objects
     include APIs::Products
     include APIs::Sequences
     include APIs::Tags

data/lib/ontraport_api/version.rb

@@ -1,3 +1,3 @@
 module OntraportApi
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/objectids.txt

@@ -1,4 +1,4 @@
-0 - contacts
+0 - Contacts
 1 - ?
 2 - Users
 3 - ?
@@ -28,4 +28,4 @@
 27 - ?
 28 - ?
 29 - ?
-30 - ?
+30 - ?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ontraport_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Jimmy Ngu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - lib/ontraport_api/apis/contacts.rb
 - lib/ontraport_api/apis/forms.rb
 - lib/ontraport_api/apis/messages.rb
+- lib/ontraport_api/apis/objects.rb
 - lib/ontraport_api/apis/products.rb
 - lib/ontraport_api/apis/sequences.rb
 - lib/ontraport_api/apis/tags.rb
@@ -114,10 +115,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 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
+has_rdoc: