rdstation-ruby-client 0.0.5 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b7a4c99778510e108208f90b32ae15a9e0d17fd
-  data.tar.gz: 82e639874139f4f0989f4c2dffdd4d82fe14c62d
+  metadata.gz: 8d8b49b1c3af26dff4944b5a246306050577424f
+  data.tar.gz: 3e4238d351ee0b2820370d4c7b9ea8285f565fd6
 SHA512:
-  metadata.gz: 1d3dc24bdddd186f3933c3c65cb32f00ff3d48bfc3c67a0dc5bc130064787e85d194c40609d8b23688e61a8783bfb8aad67fe69cebf34809b4d1e1e3ae106f00
-  data.tar.gz: b601e929310add3f122dd92c66919f82614ba3973d33004bf5e03565b7814458d59003261c4e31ed7e3c45a4fa9912573bf50a85a3777b944e8bce59d9dda173
+  metadata.gz: 14804ae659e189e1ac5f1d3880e8fe7071a1dcbdb035a237e12b06b5f7ee9113d067eb86b28fb63fe47c2dc76cd499e64b7b74bf36d1e0393ff960b892fdee91
+  data.tar.gz: 2fbd0fbe9a184a30b592747d5dcc79b4714c187b993428a69526d1f3a16f0918726ef4abd3fea21fcba23484aef92e23360ed6ab39e19817858751000a76fa1f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdstation-ruby-client (0.0.4)
+    rdstation-ruby-client (0.0.5)
       httparty (~> 0.12)
 
 GEM
@@ -53,4 +53,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.10.3
+   1.13.2

data/README.md

@@ -47,6 +47,74 @@ rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
 rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999)
 ```
 
+### Contacts
+
+#### Getting a Contact by UUID
+
+Returns data about a specific Contact
+
+```ruby
+rdstation_contacts = RDStation::Contacts.new('auth_token')
+rdstation_contacts.get_contact('uuid')
+```
+
+More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsuuid
+
+#### Getting a Contact by Email
+
+Returns data about a specific Contact
+
+```ruby
+rdstation_contacts = RDStation::Contacts.new('auth_token')
+rdstation_contacts.get_contact_by_email('email')
+```
+
+More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsemail
+
+#### Update a Contact by UUID
+
+Updates the properties of a Contact. 
+
+```ruby
+contact_info = {
+  name: "Joe Foo"
+}
+
+rdstation_contacts = RDStation::Contacts.new('auth_token')
+rdstation_contacts.update_contact('uuid', contact_info)
+```
+Contact Default Parameters
+ - email
+ - name
+ - job_title
+ - linkedin
+ - facebook
+ - twitter
+ - personal_phone
+ - mobile_phone
+ - website
+ - tags
+
+More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchDetails
+
+
+#### Upsert a Contact by identifier and value
+
+With an UPSERT like behavior, this method is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a [BAD_REQUEST error](https://developers.rdstation.com/pt-BR/error-states#conflicting). 
+
+```ruby
+contact_info = {
+  name: "Joe Foo"
+}
+
+identifier = "email"
+identifier_value = "joe@foo.bar"
+
+rdstation_contacts = RDStation::Contacts.new('auth_token')
+rdstation_contacts.upsert_contact(identifier, identifier_value, contact_info)
+```
+
+More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchUpsertDetails
 
 ## Contributing
 

data/lib/rdstation-ruby-client.rb

@@ -1,2 +1,3 @@
 require "httparty"
 require "rdstation/client"
+require "rdstation/contacts"

data/lib/rdstation/contacts.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+module RDStation
+  # More info: https://developers.rdstation.com/pt-BR/reference/contacts
+  class Contacts
+    include HTTParty
+
+    def initialize(auth_token)
+      @auth_token = auth_token
+    end
+
+    #
+    # param uuid:
+    #   The unique uuid associated to each RD Station Contact.
+    #
+    def get_contact(uuid)
+      self.class.get(base_url(uuid), :headers => required_headers)
+    end
+
+    def get_contact_by_email(email)
+      self.class.get(base_url("email:#{email}"), :headers => required_headers)
+    end
+
+    # The Contact hash may contain the following parameters:
+    # :email
+    # :name
+    # :job_title
+    # :linkedin
+    # :facebook
+    # :twitter
+    # :personal_phone
+    # :mobile_phone
+    # :website
+    # :tags
+    def update_contact(uuid, contact_hash)
+      self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => required_headers)
+    end
+
+    #
+    # param identifier:
+    #   Field that will be used to identify the contact.
+    # param identifier_value:
+    #   Value to the identifier given.
+    # param contact_hash:
+    #   Contact data
+    #
+    def upsert_contact(identifier, identifier_value, contact_hash)
+      path = "#{identifier}:#{identifier_value}"
+      self.class.patch(base_url(path), :body => contact_hash.to_json, :headers => required_headers)
+    end
+
+    private
+
+      def base_url(path = "")
+        "https://api.rd.services/platform/contacts/#{path}"
+      end
+
+      def required_headers
+        { "Authorization" => "Bearer #{@auth_token}", "Content-Type" => "application/json" }
+      end
+  end
+end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = "0.0.5"
+  VERSION = '0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: '0.1'
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - Rakefile
 - lib/rdstation-ruby-client.rb
 - lib/rdstation/client.rb
+- lib/rdstation/contacts.rb
 - lib/rdstation/version.rb
 - rdstation-ruby-client.gemspec
 - spec/lib/rdstation-ruby-client_spec.rb
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station