hubscreen 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 823f6917ca52e4a446daedd9c2d20ad2951d3897
-  data.tar.gz: 512507d2bbcd0ab768421c07ab47c2727595e37c
+  metadata.gz: 3955eb4b47abd454794b7efd470987e27ef242e9
+  data.tar.gz: 52d2bfb0428c18ac01cecf7891ef79ff21239bc1
 SHA512:
-  metadata.gz: 4be0336ac9f41fe396a77113312e1697babae7acf78a67621a49dfb255a2e53012f024c6771fac51c0e0b84bf13fc189b5e25f6a8781f81d429223798e099752
-  data.tar.gz: 7ab4c31b027932cc16dcf6506a3ad57d93558b6b46c13751e980655937c85aee44919385835f26a6edf01e865b9a707e268f5996b2e3aa6afd8e43b933d1bde9
+  metadata.gz: 7db3be09776d870ff8961683438066b629e8e0a79ca3b3c02191eb95c7df07e4943e1393ec1dafde135d9a2dda87675e77ef1a2b911092740fae71265a2db08f
+  data.tar.gz: 7fe3da303a01cbe7e1a47e9d21f5beb2d33fadffdaee7371d034d220e5944e7362978ec9505749ae671a68ab746419012a0c1ad8f559492dea5194a82e88fc67

data/README.md

@@ -43,6 +43,8 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 This project and the code therein was not created by and is not supported by HubSpot, Inc or any of its affiliates.
 
+Hubscreen is provided on an AS-IS basis. Any use of of this code in a business environment should be subjected to additional functional and integration testing prior to release.
+
 ## Copyright
 
 Copyright (c) 2016 IMIT Advisory Limited. See LICENSE.txt for further details.

data/hubscreen.gemspec

@@ -34,13 +34,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.1"
-
-
+  
   #Interactive Testing
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
 
+  #Gem Dependancies
   spec.add_dependency(%q<activesupport>, [">= 5.0.0"])
   spec.add_dependency('faraday', '>= 0.9.2')
   spec.add_dependency('multi_json', '>= 1.12.1')
+  spec.add_dependency('recursive-open-struct', '>= 1.0')
 
 end

data/lib/hubscreen.rb

@@ -4,10 +4,12 @@ require 'active_support/core_ext'
 require 'faraday'
 require 'multi_json'
 require 'cgi'
+require 'recursive-open-struct'
 
 #Rest API Helpers
 require "hubscreen/api_request"
 require "hubscreen/request"
+require "hubscreen/response"
 
 #Gem Lib Files
 require "hubscreen/version"

data/lib/hubscreen/api_request.rb

@@ -6,6 +6,7 @@ module Hubscreen
     # A new API request must pass in a Hubscreen::Request Object 
     def initialize(builder: nil)
       @request_builder = builder
+      @return_encapuslated_object = Hubscreen::Config.encapsulate_response
     end
 
     def post(params: nil, headers: nil, body: nil)
@@ -73,7 +74,7 @@ module Hubscreen
       end
     end
 
-    #protected
+    protected
 
     # Convenience accessors
 
@@ -161,17 +162,20 @@ module Hubscreen
           raise error
         end
       end
-
-      parsed_response
+      if @return_encapuslated_object
+        return Hubscreen::Response.new(parsed_response)
+      else
+        return parsed_response
+      end
     end
 
     def validate_api_key
       api_key = self.api_key
       api_endpoint = self.api_endpoint
-      unless api_key
+      unless !api_key.blank?
         raise Hubscreen::ApiError, "You must set an api_key prior to making a call"
       end
-      unless api_endpoint
+      unless !api_endpoint.blank?
         raise Hubscreen::ApiError, "You must set an api_endpoint prior to making a call"
       end
     end

data/lib/hubscreen/config.rb

@@ -5,9 +5,10 @@ require 'logger'
 module Hubscreen
   class Config
 
-    CONFIG_KEYS = [:hapikey, :base_url, :portal_id, :logger]
+    CONFIG_KEYS = [:hapikey, :base_url, :portal_id, :logger, :encapsulate_response]
     DEFAULT_LOGGER = Logger.new(STDOUT)
     DEFAULT_BASE_URL = "https://api.hubapi.com/"
+    DEFAULT_RESPONSE_ENCAPSULATION = true
 
     class << self
       attr_accessor *CONFIG_KEYS
@@ -18,6 +19,7 @@ module Hubscreen
         @base_url = config["base_url"] || DEFAULT_BASE_URL
         @portal_id = config["portal_id"] #not currenty used
         @logger = config['logger'] || DEFAULT_LOGGER
+        @encapsulate_response = config['encapsulate_response'] || DEFAULT_RESPONSE_ENCAPSULATION
         self
       end
 
@@ -26,6 +28,7 @@ module Hubscreen
         @base_url = DEFAULT_BASE_URL
         @portal_id = nil
         @logger = DEFAULT_LOGGER
+        @encapsulate_response = DEFAULT_RESPONSE_ENCAPSULATION
       end
 
       def ensure!(*params)

data/lib/hubscreen/contact.rb

@@ -1,11 +1,43 @@
+require 'pry'
 module Hubscreen
   #
   # HubSpot Contacts API
   #
   # {https://developers.hubspot.com/docs/methods/contacts/contacts-overview}
   #
+  # This is a convenience object for single Hubspot contact returned by the API 
   
-  class Contact
+  class Contact < Hubscreen::Response
+    CONTACT_KEYS = [:properties, 
+                    :vid, 
+                    :email, 
+                    :first_name, 
+                    :last_name,
+                    :hubspot_owner_id]
+
+    attr_accessor *CONTACT_KEYS
+
+    def initialize(response)
+      @raw_hash = response.raw_hash
+      @raw_response = response.raw_response
+      parse_response
+    end
+
+    def parse_response
+      @properties = @raw_response.properties
+      @vid = @raw_hash["vid"]
+      @email = @raw_hash["properties"]["email"]["value"] if @raw_hash["properties"].has_key?("email")
+      @first_name = @raw_hash["properties"]["firstname"]["value"] if @raw_hash["properties"].has_key?("firstname")
+      @last_name = @raw_hash["properties"]["lastname"]["value"] if @raw_hash["properties"].has_key?("lastname")
+      @company = @raw_hash["properties"]["company"]["value"] if @raw_hash["properties"].has_key?("company")
+      @hubspot_owner_id = @raw_hash["properties"]["hubspot_owner_id"]["value"] if @raw_hash["properties"].has_key?("hubspot_owner_id")
+    end
+
+    def inspect
+      "<Hubscreen::Contact vid:#{@vid}, email:'#{@email}', first_name:'#{@first_name}', last_name:'#{@last_name}', company:'#{@company}', hubspot_owner_id:'#{@hubspot_owner_id}', properties:<Not Shown>, raw_response:<Not Shown>, raw_hash:<Not Shown>>"
+    end
+
 
   end
+
 end

data/lib/hubscreen/response.rb

@@ -0,0 +1,28 @@
+module Hubscreen
+
+  # Hubscreen::Response
+  #
+  # Parent Class for all Hubscreen response objects. Designed for direct access to the response either through the "raw_hash" which is the hash representation of the JSON response or the "raw_response" which is the OpenStruct representation
+  #
+  # By default all APIRequests will return a Response object. To disable this, set Hubscreen.configure(encapsulate_response: false)
+
+  class Response
+    attr_accessor :raw_hash, :raw_response
+
+    def initialize(response_json_hash)
+      @raw_hash = response_json_hash
+      @raw_response = RecursiveOpenStruct.new(response_json_hash)
+    end
+
+    # Prints out the raw response in formatted JSON.
+    # This method is primarily used to aid in debugging
+    def pretty_response
+      JSON.pretty_generate(@raw_hash)
+    end
+
+    #Type Cast Helpers
+    def contact
+      Contact.new(self)
+    end
+  end
+end

data/lib/hubscreen/version.rb

@@ -1,3 +1,3 @@
 module Hubscreen
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubscreen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bryan Vaz
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Multi-purpose Ruby wrapper for the Hubspot CRM API with access to the
   raw response or Ruby objects for faster development
 email:
@@ -163,6 +177,7 @@ files:
 - lib/hubscreen/contact.rb
 - lib/hubscreen/exceptions.rb
 - lib/hubscreen/request.rb
+- lib/hubscreen/response.rb
 - lib/hubscreen/version.rb
 homepage: https://github.com/bryanvaz/hubscreen
 licenses: