projector 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5207d8f41bed6a38021ab35f4593d04b30e3acc
-  data.tar.gz: b1c1928c82e355a58e2bb3c1b30b93dd4f0a45d5
+  metadata.gz: f9985ae1b3561b3b85f5f7f7c403949c60e10736
+  data.tar.gz: c702dfc38afa37a3cdce2e02980b2ca9fe6eff7b
 SHA512:
-  metadata.gz: e498f9b613d6562a6fe07d39ce8d5070c58c3a762f687fddc431af3e87e709b1cd9c792977b1fda040b54b61dd0fda72fe020e353085202de78225f95c8c776f
-  data.tar.gz: 8568bd726be3187241a39508af57f23707a21d792ff758d1a7542295581c519825666ea90ec7ef6138090ee5dfee2f4060785fb0789035392140256f4f5b197a
+  metadata.gz: 75b9287b4b13a0d375ea9859c34f16c45c8be31689509a14ec3807759588cf84d3a48d05c2dafa17ae91671934c7cdaaeb4dd2e251a3678fad7782e95dc7339f
+  data.tar.gz: 954a2044bfdd3579d5fd3260c651f7dd65d8e9733962c76b71b46f50f53ac0817088f91e9c0c7e941ea7eacfb80011c0b48f63cabb6281069946472d3c951d81

data/Overview.md

@@ -25,14 +25,14 @@ If an error occurs, an exception will be thrown which the user can catch and ins
 The Projector SDK can encounter two types of errors when communicating with Projector's systems - Internal Server and Client Errors. All errors subclass from {Projector::Error}.
 
 ### Client Errors
-The Projector SDK has two types of Client Errors - {Projector::Unauthorized} and {Projector::BadRequest}. Making a request with safeguards for both can be done as follows:
+The Projector SDK has two types of Client Errors - {Projector::Error::Unauthorized} and {Projector::Error::BadRequest}. Making a request with safeguards for both can be done as follows:
 
 ```
 begin
   Projector.register_end_user(end_user)
-rescue Projector::Unauthorized => auth_error
+rescue Projector::Error::Unauthorized => auth_error
   puts auth_error.response_body
-rescue Projector::BadRequest => bad_request_error
+rescue Projector::Error::BadRequest => bad_request_error
   puts bad_request_error.response_body
 else
   puts 'Unknown error'
@@ -45,7 +45,7 @@ These type of errors can happen for a number of reasons; our servers might be at
 ```
 begin
   Projector.register_end_user(end_user)
-rescue Projector::InternalServerError => server_error
+rescue Projector::Error::InternalServerError => server_error
   if server_error.retry_after 
     sleep server_error.retry_after
   else
@@ -59,7 +59,7 @@ You can retry repeatedly but if the error does not eventually clear up reach out
 ```
 begin
   Projector.register_end_user(end_user)
-rescue Projector::InternalServerError => server_error
+rescue Projector::Error::InternalServerError => server_error
   # If the error does not recover, notify Projector including the Request Id
   puts server_error.request_id 
 end

data/Rakefile

@@ -23,10 +23,12 @@ desc "Publish SDK docs to GitHub Pages"
 task :publish_docs do
   system("set -x; bundle exec yardoc") or abort
   system("set -x; mv -v ./doc /tmp ") or abort
+  system("set -x; mv ./vendor /tmp") or abort # move the vendor directory to tmp for the moment
   system("set -x; git checkout gh-pages ") or abort
   system("set -x; cp -r /tmp/doc/* . ") or abort
   system("set -x; git add . ") or abort
   system("set -x; git commit --all -m 'Update docs' ") or abort
   system("set -x; git checkout master ") or abort
+  system("set -x; mv /tmp/vendor .") or abort # move the vendor directory back after we're done
   system("git push origin gh-pages")
 end

data/circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.2.3
+    version: 2.3.1
 
 dependencies:
   pre:

data/lib/projector.rb

@@ -42,6 +42,7 @@ module Projector
     end
 
     # Sets the logger instance for the Projector SDK
+    # @return [Logger]
     def logger=(x)
       @logger = x
     end

data/lib/projector/api_methods.rb

@@ -14,8 +14,8 @@ module Projector
     #    tags: ['likes_dogs']
     #   }
     #   Projector.register_end_user(end_user)
-    # @raise {Projector::Unauthorized}
-    # @raise {Projector::BadRequest}
+    # @raise {Projector::Error::Unauthorized}
+    # @raise {Projector::Error::BadRequest}
     def register_end_user(end_user)
       # If a hash is passed, use it to populate a user object
       if end_user.instance_of?(Hash)
@@ -34,8 +34,8 @@ module Projector
     # @param [Array] tags an array of tags to apply to the user
     # @example Update a user's tags
     #   Projector.set_end_user_tags('51', ['likes_dogs', 'has_dog'])
-    # @raise {Projector::Unauthorized}
-    # @raise {Projector::BadRequest}
+    # @raise {Projector::Error::Unauthorized}
+    # @raise {Projector::Error::BadRequest}
     # @return [Hash]
     def set_end_user_tags(id, tags)
       user = Projector::EndUser.new(id: id, tags: tags)
@@ -47,7 +47,7 @@ module Projector
     # @param [Hash] event a hash of the event object
     # @option event [String] :id (SecureRandom.uuid) the ID the event
     # @option event [String] :event_key the event key for this type of event
-    # @option event [String] :event_time (Time.now) the event time in ms from epoch for this event
+    # @option event [Number] :event_time ((Time.now.to_f * 1000).to_i) the event time in ms from epoch for this event
     # @option event [Hash] :target the recipient or recipients of the event
     # @option event [Hash] :event_context data for use in delivery rules and notification alert templates at Projector
     # @option event [Hash] :payload JSON data properties to be delivered on the event (deep links, metadata, etc)
@@ -67,9 +67,9 @@ module Projector
     #     target: {tags: ['likes_dogs']}    
     #   }
     #   Projector.deliver_event(event)
-    # @raise {Projector::InvalidEvent}
-    # @raise {Projector::Unauthorized}
-    # @raise {Projector::BadRequest}
+    # @raise {Projector::Error::InvalidEvent}
+    # @raise {Projector::Error::Unauthorized}
+    # @raise {Projector::Error::BadRequest}
     # @return [Hash]
     def deliver_event(event)
       # Create an Event instance if the parameter is a Hash.

data/lib/projector/client.rb

@@ -15,7 +15,7 @@ module Projector
   # If you wish to manually configure the client, create an initializer and use the {Projector::Client.configure} 
   # block to set properties as needed.
   #
-  # @example Manually configuring the Proejctor Client
+  # @example Manually configuring the Projector Client
   #   require 'projector'
   #   Projector::Client.configure do |client|
   #     client[:host] = 'https://api.projector.com'
@@ -25,9 +25,11 @@ module Projector
     include Projector::ApiMethods
     include Projector::Transport::HTTP
 
-    attr_accessor :token, :result_format
+    # @return [String] The API token for your application
+    attr_accessor :token
 
     # The current configuration parameters for all clients
+    # @return [Hash]
     def self.options
       @options ||= {
         host: ENV['PROJECTOR_API_HOST'] || 'https://api.projector.com'
@@ -37,6 +39,7 @@ module Projector
     # Replaces the global Projector client options
     #
     # @param [Hash] val the parameters to store
+    # @return [Hash]
     def self.options=(val)
       @options = val
     end
@@ -44,6 +47,7 @@ module Projector
     # Configure the global Projector client options using a block
     #
     # @yield [Hash] a hash of configuration values for the Projector Client
+    # @return [Hash]
     def self.configure
       yield options
     end
@@ -51,7 +55,7 @@ module Projector
     # Initialize a new client.
     #
     # @param [Hash] options
-    # @option options [String] :access_token The API access token
+    # @option options [String] :token The API access token
     # @option options [String] :host The API host
     def initialize(options = {})
       options = self.class.options.merge(options)
@@ -61,6 +65,7 @@ module Projector
     end
 
     # The Projector API Host
+    # @return [String]
     def host
       @options[:host]
     end

data/lib/projector/end_user.rb

@@ -1,13 +1,17 @@
 module Projector
   # Internally represents an End User in your application.
+  # @api private
   class EndUser
-    attr_accessor :id, :tags
+    # @return [String] The user's ID in your application
+    attr_accessor :id
+    # @return [Array] an array of tags to apply to the user
+    attr_accessor :tags
 
     # @param [Hash] params Properties for a user
     # @option params [String] :id the id of the user in your application
     # @option params [Array] :tags an array of tags to apply to the user
     def initialize(params = {})
-      raise Projector::InvalidEndUser.new("Invalid end user, id missing") if params[:id].nil?
+      raise Projector::Error::InvalidEndUser.new("Invalid end user, id missing") if params[:id].nil?
       if params.instance_of?(Hash)
         params.each do |k, v|
           self.send("#{k}=", v) if self.respond_to?("#{k}=")

data/lib/projector/envelope.rb

@@ -1,7 +1,9 @@
 module Projector
   # Wraps all requests to the Projector API in an envelope specifying data as an explicit parameter.
+  # @api private
   class Envelope
-    attr_accessor :schema, :data
+    # @return [Hash] data to be delivered to the Projector API
+    attr_accessor :data
 
     # @param [Object] data the data hash or array containing parameters for the API call
     def initialize(data)
@@ -15,8 +17,9 @@ module Projector
     end
 
     # Serializes the envelope to the correct Projector-defined envelope hash format
+    # @return [Hash]
     def to_hash(params = {})
-      raise Projector::InvalidEnvelope unless @data
+      raise Projector::Error::InvalidEnvelope unless @data
       {
         data: payload
       }

data/lib/projector/error.rb

@@ -5,53 +5,60 @@ module Projector
     attr_accessor :request
     # The response object (if present)
     attr_accessor :response
-    # The http response body, if present
+    # @return [Hash] The http JSON response body, if present
     attr_accessor :response_body
-    # The Projector API request id
+    # @return [String] The Projector API request ID
     attr_accessor :request_id
-  end
 
-  # Raised when Projector returns a 400 HTTP status code.
-  class BadRequest < Error; end
+    # Raised when Projector returns a 400 HTTP status code.
+    class BadRequest < Error; end
 
-  # Raised when Projector returns a 401 HTTP status code.
-  class Unauthorized < Error; end
+    # Raised when Projector returns a 401 HTTP status code.
+    class Unauthorized < Error; end
 
-  # Raised when Projector returns a 403 HTTP status code.
-  class Forbidden < Error; end
+    # Raised when Projector returns a 403 HTTP status code.
+    class Forbidden < Error; end
 
-  # Raised when Projector returns a 404 HTTP status code.
-  class NotFound < Error; end
+    # Raised when Projector returns a 404 HTTP status code.
+    class NotFound < Error; end
 
-  # Raised when Projector returns a 406 HTTP status code.
-  class NotAcceptable < Error; end
+    # Raised when Projector returns a 406 HTTP status code.
+    class NotAcceptable < Error; end
 
-  # Raised when Projector returns a 422 HTTP status code.
-  class UnprocessableEntity < Error; end
+    # Raised when Projector returns a 422 HTTP status code.
+    class UnprocessableEntity < Error; end
 
-  # Raised when Projector returns a 500 HTTP status code.
-  class InternalServerError < Error;
-    attr_accessor :retry_after
-  end
+    # Raised when Projector returns a 500 HTTP status code.
+    class InternalServerError < Error;
+      # @return [Number] The time in seconds to wait before retrying this request
+      attr_accessor :retry_after
+    end
 
-  # Raised when Projector returns a 501 HTTP status code.
-  class NotImplemented < Error; end
+    # Raised when Projector returns a 501 HTTP status code.
+    class NotImplemented < Error; end
 
-  # Raised when Projector returns a 502 HTTP status code.
-  class BadGateway < Error; end
+    # Raised when Projector returns a 502 HTTP status code.
+    class BadGateway < Error; end
 
-  # Raised when Projector returns a 503 HTTP status code.
-  class ServiceUnavailable < Error; end
+    # Raised when Projector returns a 503 HTTP status code.
+    class ServiceUnavailable < Error; end
 
-  # Raised when a unique ID is required but not provided.
-  class UniqueIDRequired < Error; end
+    # Raised when a unique ID is required but not provided.
+    class UniqueIDRequired < Error; end
 
-  # Raised when an invalid End User is sumbitted to the Projector API.
-  class InvalidEndUser < StandardError; end
+    # Raised when an invalid End User is sumbitted to the Projector API.
+    class InvalidEndUser < Error; end
 
-  # Raised when an invalid event is submitted to the Projector API.
-  class InvalidEvent < StandardError; end
+    # Raised when an invalid event is submitted to the Projector API.
+    class InvalidEvent < Error; end
 
-  # Raised when an invalid envelope is submitted to the Projector API.
-  class InvalidEnvelope < StandardError; end
+    # Raised when an invalid envelope is submitted to the Projector API.
+    class InvalidEnvelope < Error; end
+
+    # Raised when the HTTP client follows too many HTTP redirects.
+    class TooManyRedirects < Error
+      # @return [Number] The redirect count that caused this error
+      attr_accessor :redirect_count
+    end
+  end
 end

data/lib/projector/event.rb

@@ -2,11 +2,12 @@ module Projector
   require 'securerandom'
 
   # Internally represents an event being sent to the Projector API.
+  # @api private
   class Event
     
     # @param [Hash] params a hash of properties to send with the event
     # @option params [String] id (SecureRandom.uuid) the unique identifier for this event in your system
-    # @option params [Number] event_time (Time.now) the ms since epoch for this event
+    # @option params [Number] event_time ((Time.now.to_f * 1000).to_i) the ms since epoch for this event
     # @option params [Hash] event_context data providing context for the event. Used in delivery rules, templates, and more at Projector.
     # @option params [Hash] target containing either an *end_users* or *tags* key and a corresponding hash of values.
     def initialize(params)

data/lib/projector/transport/http.rb

@@ -9,30 +9,30 @@ module Projector
       require 'json'
       require 'projector/error'
 
-      # Maximum URI redrects to follow before failing.
-      MAX_REDIRECTS = 2
-
-      # Status code to exception map.
-      ERROR_MAP = {
-        400 => Projector::BadRequest,
-        401 => Projector::Unauthorized,
-        403 => Projector::Forbidden,
-        404 => Projector::NotFound,
-        406 => Projector::NotAcceptable,
-        422 => Projector::UnprocessableEntity,
-        500 => Projector::InternalServerError,
-        501 => Projector::InternalServerError,
-        502 => Projector::InternalServerError,
-        503 => Projector::InternalServerError
-      }
-
       [:get, :post, :put, :delete, :patch].each do |method|
         define_method method do |*args|
           json_request(method, *args)
         end
       end
 
-      protected
+      private
+
+      # Maximum URI redrects to follow before failing.
+      MAX_REDIRECTS = 2
+
+      # Status code to exception map.
+      ERROR_MAP = {
+        400 => Projector::Error::BadRequest,
+        401 => Projector::Error::Unauthorized,
+        403 => Projector::Error::Forbidden,
+        404 => Projector::Error::NotFound,
+        406 => Projector::Error::NotAcceptable,
+        422 => Projector::Error::UnprocessableEntity,
+        500 => Projector::Error::InternalServerError,
+        501 => Projector::Error::InternalServerError,
+        502 => Projector::Error::InternalServerError,
+        503 => Projector::Error::InternalServerError
+      }
 
       # Makes an HTTP Request
       #
@@ -76,7 +76,7 @@ module Projector
 
           # Make sure we aren't in a giant redirect loop
           if redirect_count >= MAX_REDIRECTS
-            err = TooManyRedirectsError.new
+            err = Projector::Error::TooManyRedirects.new
             err.request = request
             err.response = response
             err.redirect_count = redirect_count
@@ -238,12 +238,7 @@ module Projector
           end
         end
       end
-
-      # Raised when the HTTP client follows too many HTTP redirects
-      class TooManyRedirectsError < Projector::Error
-        # The redirect count that caused this error
-        attr_accessor :redirect_count
-      end
+      private_constant :Response
     end
   end
 end

data/lib/projector/version.rb

@@ -1,6 +1,6 @@
 module Projector
   # Current SDK Version
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 
   # Current API Version
   API_VERSION = 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: projector
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Projector
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
@@ -88,3 +88,4 @@ signing_key:
 specification_version: 4
 summary: Ruby SDK for interacting with the Projector SDK
 test_files: []
+has_rdoc: