verticalresponse 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96318a9b541c169be00b68a96b084904397d385b
-  data.tar.gz: 89871561f44271648e2ff68bf383684bcb8d9cb7
+  metadata.gz: ea638bd9b5bc61e712489d4cdea16315cc2899ab
+  data.tar.gz: 673029928047e551a3b94e96797b76c86256070c
 SHA512:
-  metadata.gz: 2fb79d0ec033543228f4eb5d8152621c0a129cb775537342f88f05a0b2d8ca567a41543008ce864a8e3caf700dce5dc05802a8f065b0375594ee07e19a432247
-  data.tar.gz: cac28274b484ff93c5cbca9b74d153b3036308dfafbb1b56ef7b5b83351b6e43afccf6d13f9d18c6e031fcbf5e711a752d65a3e558f75c57d81a6f7aab9aee94
+  metadata.gz: 746f527074d0599a6aec04addd475079282b6ea5587165bb26f61433f75cb8fa7a1f463e86d0b9a23456021b67dd70e13637b439b4d0aaffa3da812e74744387
+  data.tar.gz: b0c59b01284d31c53552184cc4b7ddba9a489339ede35e0daa6581f007a61ffc411cff5f8605957f1a32f3d1eee6528c95f6a4fc504d3c3f297c8859a45d5cc2

data/README.md

@@ -10,22 +10,48 @@ Based on https://github.com/VerticalResponse/v1wrappers/
 New Functionality
 -----------------
 
-Allows instantiating oauth clients by access_token, to access the VerticalResponse API in an object-oriented fashion.
+Allows instantiating oauth clients by access_token, to access the VerticalResponse API in an object-oriented fashion. The calls are object-oriented in the sense that you can instantate a client with its access_token. This is not possible with the original wrappers.
 
 ```ruby
-oauth_client = VerticalResponse::API::OAuth.new access_token
-```
+client = VerticalResponse::API::OAuth.new access_token
 
-This allows us to get the lists for a verticalresponse user with
-```ruby
-oauth_client.lists
-```
+# Get all lists
+client.lists
 
-or the clients with
-```ruby
-oauth_client.clients
+# Get a specific list
+client.find_list("<id>")
+
+# Get contacts in a specific list
+client.find_list("<id>").contacts
+
+# Create multiple contacts in a specific list
+client.find_list("<id>").create_contacts([{
+    email: "some@email.com",
+    first_name: "some first name",
+    last_name: "some last name",
+    custom: {
+      field: "some custom field"
+    }
+  },
+  {
+    email: "another@email.com",
+    first_name: "another first name",
+    last_name: "another last name",
+    custom: {
+      field: "another custom field"
+    }
+  }
+])
+
+# Get all contacts
+client.contacts
+
+# Get all custom fields
+client.custom_fields
 ```
 
+And a few other calls as well. Not all wrapper methods are supported, but you're more than welcome to implement them yourself and submit pull requests.
+
 Requirements
 ----------
 Ruby 1.9+ (compatible with Ruby 2.1.1)
@@ -36,4 +62,4 @@ Note: I only tested these requirements as much as I needed to (not for all funct
 
 Contribute
 ----------
-I only built this for what I needed, and I know it's pretty limited. Contributions are more than welcome
+The features of this gem were built as needed, and it is pretty limited. Contributions are more than welcome!

data/lib/verticalresponse.rb

@@ -1,21 +1,26 @@
 require 'httparty'
 
-require_relative 'client.rb'
-require_relative 'contact.rb'
-require_relative 'custom_field.rb'
-require_relative 'email.rb'
-require_relative 'error.rb'
-require_relative 'list.rb'
-require_relative 'message.rb'
-require_relative 'oauth.rb'
-require_relative 'resource.rb'
-require_relative 'response.rb'
-require_relative 'social_post.rb'
+require_relative 'verticalresponse/api/oauth.rb'
+
+require_relative 'verticalresponse/api/client.rb'
+require_relative 'verticalresponse/api/contact.rb'
+require_relative 'verticalresponse/api/custom_field.rb'
+require_relative 'verticalresponse/api/email.rb'
+require_relative 'verticalresponse/api/error.rb'
+require_relative 'verticalresponse/api/list.rb'
+require_relative 'verticalresponse/api/message.rb'
+require_relative 'verticalresponse/api/resource.rb'
+require_relative 'verticalresponse/api/response.rb'
+require_relative 'verticalresponse/api/social_post.rb'
 
 module VerticalResponse
+  API_VERSION  = "v1"
+
   CONFIG = { 
     host: 'vrapi.verticalresponse.com',
     port: "",
     protocol: 'https'
   }
-end
+end
+
+$LOAD_PATH << File.dirname(__FILE__) unless $LOAD_PATH.include?(File.dirname(__FILE__))

data/lib/{client.rb → verticalresponse/api/client.rb}

@@ -8,6 +8,8 @@ require_relative 'response'
 module VerticalResponse
   module API
     class Client
+      attr_reader :access_token
+
       include HTTParty
 
       format :json
@@ -20,7 +22,7 @@ module VerticalResponse
         # Assign the headers required by our partner Mashery
         def assign_headers(headers_info = {})
           access_token = headers_info[:access_token]
-          add_default_query_param(:access_token, access_token)
+          add_default_query_param(:access_token, access_token) unless access_token.nil?
         end
 
         def embed_resource(resource, resource_id = nil)
@@ -32,7 +34,7 @@ module VerticalResponse
         # It builds the URI based on the values from the API configuration file.
         # 'host' must be defined (unless host_uri is specified as an input param)
         # otherwise the method will raise an exception.
-        def base_uri(host_uri = nil)
+        def base_service_uri(host_uri = nil)
           uri = host_uri
           unless uri
             unless VerticalResponse::CONFIG[:host]
@@ -58,6 +60,23 @@ module VerticalResponse
           URI.join(uri, File.join(*paths))
         end
 
+        def base_uri(host_uri = nil)
+          @base_uri ||= File.join(base_service_uri(host_uri).to_s, *resource_uri_suffix)
+        end
+
+        # Allow getting contacts from a list, creating contacts inside a list, etc.
+        # This works better than embed_resource, since it avoids conflicts between
+        # multiple actors. In a multithreaded environment this is obvious, but
+        # in a multi-process environment conflicts can still happen, so we want
+        # to set the prefix of a uri on instances, not at the class level.
+        def base_uri_with_prefix(*prefix)
+          File.join(base_service_uri.to_s, *prefix, *resource_uri_suffix)
+        end
+
+        def resource_uri_suffix
+          []
+        end
+
         def build_params(params, query_params = {})
           request_params = {}
           request_params[:body] = params if params
@@ -97,6 +116,27 @@ module VerticalResponse
           end
           uri
         end
+
+        def resource_uri_with_prefix(prefix, *additional_paths)
+          uri = base_uri_with_prefix(prefix)
+          if additional_paths.any?
+            # Convert all additional paths to string
+            additional_paths = additional_paths.map do |path|
+              # We need to escape each path in case it contains caracters that
+              # are not appropriate to use as part of an URL.
+              # Unescape and then escape again in case the path is already escaped
+              URI::escape(URI::unescape(path.to_s))
+            end
+            uri = File.join(uri, *additional_paths)
+          end
+          uri
+        end
+
+        # Used when posting
+        # The access_token at this time seems to only work as GET parameter
+        def resource_uri_with_token(access_token, *additional_paths)
+          resource_uri(*additional_paths) + "?access_token=#{access_token}"
+        end
       end
 
       # Set default headers for OAuth authentication
@@ -104,7 +144,8 @@ module VerticalResponse
 
       attr_accessor :response
 
-      def initialize(response)
+      def initialize(response, access_token = nil)
+        @access_token = access_token
         self.response = response
       end
     end

data/lib/{contact.rb → verticalresponse/api/contact.rb}

@@ -13,13 +13,19 @@ module VerticalResponse
   module API
     class Contact < Resource
       class << self
-        # Base URI for the Contact resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'contacts')
+        def resource_uri_suffix
+          ['contacts']
         end
 
         def fields(options = {})
-          Response.new get(resource_uri('fields'), build_query_params(options))
+          Response.new get(resource_uri('fields'), build_query_params(options), options[:access_token])
+        end
+
+        def find_by_email(options = {})
+          validate_supported_method!(:find)
+          response = Response.new(get(resource_uri,build_query_params(options)), options[:access_token])
+
+          object_collection(response, options[:access_token])
         end
       end
 
@@ -31,13 +37,16 @@ module VerticalResponse
 
       # Returns all the lists this contact belongs to
       def lists(options = {})
+        options.merge!(access_token: @access_token)
         @list_class.all(options)
       end
 
       # Returns all the messages targetted to the current contact
       def messages(options = {})
+        options.merge!(access_token: @access_token)
         @message_class.all(options)
       end
     end
+
   end
 end

data/lib/{custom_field.rb → verticalresponse/api/custom_field.rb}

@@ -12,9 +12,8 @@ module VerticalResponse
   module API
     class CustomField < Resource
       class << self
-        # Base URI for the Message resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'custom_fields')
+        def resource_uri_suffix
+          ['custom_fields']
         end
 
         def id_regexp

data/lib/{email.rb → verticalresponse/api/email.rb}

@@ -13,9 +13,8 @@ module VerticalResponse
   module API
     class Email < Resource
       class << self
-        # Base URI for the Email resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'messages', 'emails')
+        def resource_uri_suffix
+          ['messages', 'emails']
         end
 
         # Overwrite from parent class since it's a special type of

data/lib/{list.rb → verticalresponse/api/list.rb}

@@ -12,9 +12,8 @@ module VerticalResponse
   module API
     class List < Resource
       class << self
-        # Base URI for the List resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'lists')
+        def resource_uri_suffix
+          ['lists']
         end
       end
 
@@ -26,27 +25,37 @@ module VerticalResponse
 
       # Returns all the messages targetted to the current list
       def messages(options = {})
-        @message_class.all(options)
+        @access_token ||= options[:access_token]
+        @message_class.all(options.merge(access_token: @access_token))
       end
 
       # Returns all the contacts that belong to the list
       def contacts(options = {})
-        @contact_class.all(options)
+        @access_token ||= options[:access_token]
+        @contact_class.all(options.merge(access_token: @access_token))
       end
 
       def find_contact(contact_id, options = {})
-        @contact_class.find(contact_id, options)
+        @access_token ||= options[:access_token]
+        @contact_class.find(contact_id, options.merge(access_token: @access_token))
+      end
+
+      def find_contact_by_email(email, options = {})
+        @access_token ||= options[:access_token]
+        @contact_class.find_by_email(options.merge(access_token: @access_token, email_address: email))
       end
 
       # Creates a contact for the list with the parameters provided
       def create_contact(params)
-        @contact_class.create(params)
+        @access_token ||= params[:access_token]
+        @contact_class.create(params.merge(access_token: @access_token))
       end
 
       # Creates contacts in batch for the list with the parameters provided
       def create_contacts(params)
+        @access_token ||= params[:access_token]
         params = { :contacts => params } if params.is_a?(Array)
-        @contact_class.create(params)
+        @contact_class.create(params.merge(access_token: @access_token))
       end
 
       # Deletes a contact from the list
@@ -57,7 +66,7 @@ module VerticalResponse
         contact_to_delete.delete
       end
 
-      # Deletes contacts in batch from the list
+      # Deletes contacts in batch from the lists
       def delete_contacts(contact_emails)
         Response.new @contact_class.delete(
           @contact_class.resource_uri,

data/lib/{message.rb → verticalresponse/api/message.rb}

@@ -14,8 +14,8 @@ module VerticalResponse
     class Message < Resource
       class << self
         # Base URI for the Message resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'messages')
+        def resource_uri_suffix
+          ['messages']
         end
 
         # Overwritting this method from the parent class since we want to
@@ -31,7 +31,7 @@ module VerticalResponse
                 message_class = SocialPost
               end
             end
-            message_class.new(response_item)
+            message_class.new(response_item, access_token)
           end
         end
       end

data/lib/verticalresponse/api/oauth.rb

@@ -0,0 +1,113 @@
+# This class provides users the ability to generate oAuth tokens for the
+# VerticalResponse API.
+#
+# Check the examples/sample code to know how to use this class.
+
+require_relative 'client'
+
+module VerticalResponse
+  module API
+    class OAuth < Client
+      # We expect HTML format as the API might redirect to a signin page or
+      # return errors in HTML format
+      format :html
+
+      def initialize(access_token)
+        @access_token = access_token
+      end
+
+      class << self
+        # Overwrite this method as we don't need to setup headers for
+        # OAuth calls
+        def assign_headers(*args)
+        end
+
+        def resource_uri_suffix
+          ['oauth']
+        end
+
+        # client_id is the application key
+        def authorize(client_id = "", redirect_uri = "")
+          get(
+            resource_uri('authorize'),
+            build_query_params({ :client_id => client_id, :redirect_uri => redirect_uri })
+          )
+        end
+
+        def access_token(auth_code,
+                         redirect_uri = "",
+                         client_id = "",
+                         client_secret = "")
+          get(
+            resource_uri('access_token'),
+            build_query_params({
+              :client_id => client_id,
+              :client_secret => client_secret,
+              :code => auth_code,
+              :redirect_uri => redirect_uri
+            })
+          )
+        end
+      end
+
+      # ============================================================
+      # We want to access instances of OAuth with OOP, so we'll include
+      # some wrappers that let us use do the following:
+      #   client = OAuth.new(access_token)
+      #   client.lists
+      #   client.contacts
+      #
+      # Please note, using static libraries isn't "object-oriented".
+      # Using instances is. The client in the example above is an
+      # example of an instance. This whole gem uses libraries
+      # instead of instances which is kindof bad.
+      #
+      # TODO: this whole gem should be more object-oriented, but for
+      # now this should work
+      # ============================================================
+      def lists(params = {})
+        params.merge!({access_token: @access_token})
+        VerticalResponse::API::List.all(params)
+      end
+
+      # Afterwards, can use 'create_contact', etc.
+      def find_list(list_id, params = {})
+        params.merge!({access_token: @access_token})
+        VerticalResponse::API::List.find(list_id, params)
+      end
+
+      def contacts(params = {}, *path_prefix)
+        params.merge!({access_token: @access_token})
+        VerticalResponse::API::Contact.all(params, path_prefix)
+      end
+
+      def find_contact(contact_id, params = {})
+        params.merge!({access_token: @access_token})
+        VerticalResponse::API::Contact.find(contact_id, params)
+      end
+
+      def find_contact_by_email(email, params = {})
+        params.merge!({access_token: @access_token})
+        params.merge!({email_address: email})
+        VerticalResponse::API::Contact.find_by_email(params)
+      end
+
+      # One or more contacts; if creating more => custom fields aren't created remotely
+      # Attempt to create custom fields remotely => error
+      #
+      # For multiple, use contacts: [{...},{...}]
+      def create_contacts(contact_details, *path_prefix)
+        contact_details = { contacts: contact_details } if contact_details.is_a?(Array) 
+        VerticalResponse::API::Contact.create(
+          contact_details.merge(access_token: @access_token), 
+          path_prefix
+        )
+      end
+
+      def custom_fields(params = {})
+        params.merge!({access_token: @access_token})
+        VerticalResponse::API::CustomField.all(params)
+      end
+    end
+  end
+end

data/lib/{resource.rb → verticalresponse/api/resource.rb}

@@ -55,46 +55,56 @@ module VerticalResponse
           url.match(/#{ resource_name }\/(#{ id_regexp })/)[1]
         end
 
-        ##################################
-        # Common object oriented methods #
-        ##################################
+        ##################
+        # Common methods #
+        ##################
 
         # Returns a collection of current class objects.
         # Useful for when we need to have an object oriented way to
         # handle a list of items from an API response
-        def object_collection(response)
+        def object_collection(response, access_token = nil)
           response.handle_collection do |response_item|
-            self.new(response_item)
+            self.new(response_item, access_token)
           end
         end
 
         # Returns all the objects of the current class
-        def all(options = {})
+        # The prefix is more or less a hack, to allow viewing contacts inside lists
+        # with one call
+        def all(options = {}, path_prefix = [])
           validate_supported_method!(:all)
 
-          response = Response.new get(resource_uri, build_query_params(options))
+          uri = resource_uri_with_prefix(path_prefix)
+          response = Response.new(get(uri, build_query_params(options)), options[:access_token])
 
-          object_collection(response)
+          object_collection(response, options[:access_token])
         end
 
         # Find and return an object of the current class based on its ID
         def find(id, options = {})
           validate_supported_method!(:find)
+          response = Response.new(get(resource_uri(id),build_query_params(options)))
 
-          response = Response.new get(resource_uri(id), build_query_params(options))
-
-          self.new(response)
+          self.new(response, options[:access_token])
         end
 
         # Creates a new object of the current class with the parameters provided
-        def create(params)
+        def create(params, path_prefix = [])
+          access_token = params[:access_token]
+          params.delete :access_token
+
           validate_supported_method!(:create)
 
-          response = Response.new post(
-            resource_uri,
-            build_params(params)
+          uri = resource_uri_with_prefix(path_prefix)
+
+          # VerticalResponse doesn't like it when we pass the access_token via POST
+          uri += (uri.include? "?") ? "&" : "?"
+          uri += "access_token=#{access_token}"
+
+          response = Response.new(
+            post(uri, build_params(params))
           )
-          self.new(response)
+          self.new(response, access_token)
         end
       end
 
@@ -117,21 +127,29 @@ module VerticalResponse
       end
 
       def update(params)
+        @access_token = params[:access_token]
+        params.delete :access_token
         self.class.validate_supported_method!(:update)
 
-        response = Response.new self.class.put(
-          self.class.resource_uri(id),
-          self.class.build_params(params)
+        response = Response.new(
+          self.class.put(
+            self.class.resource_uri_with_token(@access_token, id),
+            self.class.build_params(params)
+          )
         )
-        self.class.new(response)
+        self.class.new(response, @access_token)
       end
 
       def delete(params = {})
+        @access_token = params[:access_token]
+        params.delete :access_token
         self.class.validate_supported_method!(:delete)
 
-        Response.new self.class.delete(
-          self.class.resource_uri(id),
-          self.class.build_params(params)
+        Response.new(
+          self.class.delete(
+            self.class.resource_uri_with_token(@access_token, id),
+            self.class.build_params(params)
+          )
         )
       end
 
@@ -145,7 +163,9 @@ module VerticalResponse
           uri = self.class.resource_uri(id, 'stats')
         end
 
-        Response.new self.class.get(uri, self.class.build_query_params(options))
+        Response.new(
+          self.class.get(uri, self.class.build_query_params(options))
+        )
       end
     end
   end

data/lib/{response.rb → verticalresponse/api/response.rb}

@@ -6,9 +6,10 @@ require_relative 'error'
 module VerticalResponse
   module API
     class Response
-      attr_reader :url, :items, :attributes, :links, :success, :error, :raw_response
+      attr_reader :url, :items, :attributes, :links, :success, :error,
+                  :raw_response, :access_token
 
-      def initialize(response)
+      def initialize(response, access_token = nil)
         @url =          response['url']
         @items =        response['items']
         @attributes =   response['attributes']
@@ -17,6 +18,8 @@ module VerticalResponse
         @error =        response['error']
         @raw_response = response
 
+        @access_token = access_token
+
         handle_error unless success?
       end
 
@@ -24,7 +27,7 @@ module VerticalResponse
       # for each one of them
       def handle_collection
         items.map do |item|
-          yield(Response.new(item))
+          yield(Response.new(item, @access_token))
         end
       end
 

data/lib/{social_post.rb → verticalresponse/api/social_post.rb}

@@ -13,9 +13,8 @@ module VerticalResponse
   module API
     class SocialPost < Resource
       class << self
-        # Base URI for the Email resource
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'messages', 'social_posts')
+        def resource_uri_suffix
+          ['messages', 'social_posts']
         end
 
         # Overwrite from parent class since it's a special type of

metadata

@@ -1,42 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: verticalresponse
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
+- Cosmin Atanasiu
 - Sridhar  Devulkar
 - Esteban  Munoz
-- Cosmin Atanasiu
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2014-06-18 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: 'Gem used to connect to VerticalResponse.com''s API '
 email:
+- innorogue@gmail.com
 - sdevulkar@verticalresponse.com
 - emunoz@verticalresponse.com
-- innorogue@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- lib/verticalresponse.rb
+- lib/verticalresponse/api/oauth.rb
+- lib/verticalresponse/api/client.rb
+- lib/verticalresponse/api/custom_field.rb
+- lib/verticalresponse/api/error.rb
+- lib/verticalresponse/api/message.rb
+- lib/verticalresponse/api/resource.rb
+- lib/verticalresponse/api/social_post.rb
+- lib/verticalresponse/api/contact.rb
+- lib/verticalresponse/api/email.rb
+- lib/verticalresponse/api/list.rb
+- lib/verticalresponse/api/response.rb
 - LICENSE
 - README.md
-- lib/client.rb
-- lib/contact.rb
-- lib/custom_field.rb
-- lib/email.rb
-- lib/error.rb
-- lib/list.rb
-- lib/message.rb
-- lib/oauth.rb
-- lib/resource.rb
-- lib/response.rb
-- lib/social_post.rb
-- lib/verticalresponse.rb
 homepage: 
 licenses:
 - GPLv3
@@ -57,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Gem used to connect to VerticalResponse.com's API

data/lib/oauth.rb

@@ -1,67 +0,0 @@
-# This class provides users the ability to generate oAuth tokens for the
-# VerticalResponse API.
-#
-# Check the examples/sample code to know how to use this class.
-
-require_relative 'client'
-
-module VerticalResponse
-  module API
-    class OAuth < Client
-      # We expect HTML format as the API might redirect to a signin page or
-      # return errors in HTML format
-      format :html
-
-      def initialize(access_token)
-        @access_token = access_token
-      end
-
-      def lists
-        VerticalResponse::API::List.all({"access_token" => @access_token})
-      end
-
-      def contacts
-        VerticalResponse::API::Contact.all({"access_token" => @access_token})
-      end
-
-      def get_list(list_id)
-        VerticalResponse::API::List.find(list_id, {"access_token" => @access_token})
-      end
-
-      class << self
-        # Overwrite this method as we don't need to setup headers for
-        # OAuth calls
-        def assign_headers(*args)
-        end
-
-        # Base URI for the OAuth calls
-        def base_uri(*args)
-          @base_uri ||= File.join(super.to_s, 'oauth')
-        end
-
-        # client_id is the application key
-        def authorize(redirect_uri = "", client_id = "")
-          get(
-            resource_uri('authorize'),
-            build_query_params({ :client_id => client_id, :redirect_uri => redirect_uri })
-          )
-        end
-
-        def access_token(auth_code,
-                         redirect_uri = "",
-                         client_id = "",
-                         client_secret = "")
-          get(
-            resource_uri('access_token'),
-            build_query_params({
-              :client_id => client_id,
-              :client_secret => client_secret,
-              :code => auth_code,
-              :redirect_uri => redirect_uri
-            })
-          )
-        end
-      end
-    end
-  end
-end