unloq 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7897418f6ca8c9fc33545aae4d46bccb0b54e56
-  data.tar.gz: 39d379fe3dbc9d56baaa4ea646757e59484e1d70
+  metadata.gz: 484a542107975d1eddde65b5457ddaa4c90d5be8
+  data.tar.gz: 845a68b9301f4d9163368097bfa5a98e4dcdc2c9
 SHA512:
-  metadata.gz: bdde0af33b9ca715b957d9a42bb45d3c74b0257e167a4752e3f096d10d0207c83ade10c0a84ab071acef278d996b8fe1b2e47ffd8e0f33c4053618fd163a4e34
-  data.tar.gz: ce701c4a86e4739aa93f9bc7483c3edf60c23015be138bf65cd797251fdcc7de36688f1c27ebaf8d510f0877621f7855860fb63d01da54dd5fa08568329c76c2
+  metadata.gz: 98c959380035e40cbd043e3d12840061e713b22c859885f7ff293d7a56bd126a3729dcec9b6be33dff47ffc8bfa06fd30940801dae584be6b67cb74c67d060b6
+  data.tar.gz: 22fb4a91441992cd467335ed60c15a64a45754800ec4616d3b9bec53ddd4b196e0236376eee35fce3f636c58dad99e1eb7b384b7b92b8185836cbee6eb7a96fe

data/lib/unloq/achievements.rb

@@ -3,8 +3,8 @@ module Unloq
 
     # Create an achievement via the Unloq API
     #
-    # @param verb [String] verb The verb for which this achievement should be unlocked
-    # @param observation_count [Integer] observation_count The number of times the event must occur to unlock this achievement
+    # @param verb [String] The verb for which this achievement should be unlocked
+    # @param observation_count [Integer] The number of times the event must occur to unlock this achievement
     # @param author [Unloq::Entity] An individual author, if passed this achievement will only be attainable by this author. Required if author_type is not defined.
     # @param recipient [Unloq::Entity] An individual recipient that must be acted on to attain this achievement. Required if recipient_type is not defined.
     # @param author_type [String] An individual author type, if passed this achievement will only be attaintable by authors of this type. Required if author is not defined.

data/lib/unloq/client.rb

@@ -8,8 +8,8 @@ module Unloq
 
     # Initialize the client class that will be used for all Unloq interactions.
     #
-    # @param [String] api_key Your Unloq api key.
-    # @param [String] namespace The namespace under which Unloq events should be created, e.g. appname-dev
+    # @param api_key [String] Your Unloq api key.
+    # @param namespace [String] The namespace under which Unloq events should be created, e.g. appname-dev
 
     def initialize api_key: nil, namespace: nil
       unless api_key && namespace
@@ -22,8 +22,8 @@ module Unloq
 
     # Make a post request to the Unloq API
     #
-    # @param [String] endpoint The resource endpoint, e.g. /events
-    # @param [Hash] body The body payload that should be POSTed
+    # @param endpoint [String] The resource endpoint, e.g. /events
+    # @param body [Hash] The body payload that should be POSTed
 
     def post endpoint, body = {}
       body.merge!(api_key: api_key, namespace: namespace)

data/lib/unloq/entity.rb

@@ -2,6 +2,10 @@ module Unloq
   class Entity
     attr_reader :id, :type, :meta
 
+    # Initialize an instance of an unloq entity. This has subclasses for Author and Recipient for ease of understanding.
+    # @param id [String] The ID of the entity (may also be an integer), e.g. 1 or '1'
+    # @param type [String] The type of the entity, e.g. 'User'
+
     def initialize id: nil, type: nil, meta: {}
       unless id && type
         raise ArgumentError.new("You must include both an id and a type, e.g. #{self.class.to_s}.new(id: 1, type: 'User')")

data/lib/unloq/events.rb

@@ -3,10 +3,10 @@ module Unloq
 
     # Create an event via the Unloq API
     #
-    # @param [Unloq::Entity] author Author involved in the event
-    # @param [String] verb The verb of the event
-    # @param [Unloq::Entity] recipient Recipient involved in the event
-    # @param [Hash] meta A hash of additional metadata to send with the request
+    # @param author [Unloq::Entity] Author involved in the event
+    # @param verb [String] The verb of the event
+    # @param recipient [Unloq::Entity] Recipient involved in the event
+    # @param meta [Hash] A hash of additional metadata to send with the request
 
     def create_event author, verb, recipient, meta = {}
       validate_author(author)

data/lib/unloq/version.rb

@@ -1,3 +1,3 @@
 module Unloq
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unloq
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matt Mueller