unloq 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 484a542107975d1eddde65b5457ddaa4c90d5be8
-  data.tar.gz: 845a68b9301f4d9163368097bfa5a98e4dcdc2c9
+  metadata.gz: cff86a832993541cd2daceb983e0815d0ce04a85
+  data.tar.gz: a932aafed57edd407713b2facd08dace8d84d6bf
 SHA512:
-  metadata.gz: 98c959380035e40cbd043e3d12840061e713b22c859885f7ff293d7a56bd126a3729dcec9b6be33dff47ffc8bfa06fd30940801dae584be6b67cb74c67d060b6
-  data.tar.gz: 22fb4a91441992cd467335ed60c15a64a45754800ec4616d3b9bec53ddd4b196e0236376eee35fce3f636c58dad99e1eb7b384b7b92b8185836cbee6eb7a96fe
+  metadata.gz: 86dc513b6731813b6da1442614dddfe27a186f66842d92d1cbf50104417a4c235dbf4fdb8e449cd2ee4dc62c12480c90f921dc7753b7d70334a588353db43e88
+  data.tar.gz: 511da23076ac5d92ee3c050a963e7e856887f3684ca7f62a77abb3d944edfd3fbcf0c9e869d36fe244ad12675d8e8eaa52053abda25c6d9eff3a739f8e4bc6cc

data/README.md

@@ -35,6 +35,59 @@ recipient = Unloq::Recipient.new(id: 13, type: 'User')
 client.create_event(author, 'followed', recipient)
 ```
 
+Lookup an event:
+
+```ruby
+author    = Unloq::Author.new(id: 12, type: 'User')
+recipient = Unloq::Recipient.new(id: 13, type: 'User')
+
+# Note: this method will raise an Unloq::APIError::NotFoundError with 
+# a status of 404 if the event is not found
+
+client.lookup_event(author, 'followed', recipient)
+```
+
+
+### Achievements
+
+Create an achievement
+
+```ruby
+# See the documentation for additional keyword arguments
+
+# Creating achievements based only on author and recipient types 
+# that are triggered after 2 observations
+
+client.create_achievement('viewed-page', 2, author_type: 'User', recipient_type: 'Post')
+
+# Creating achievements with author and recipient as specific entities 
+# that are triggered after 2 observations
+
+author    = Unloq::Author.new(id: 12, type: 'User')
+recipient = Unloq::Recipient.new(id: 13, type: 'User')
+client.create_achievement('poked', 2, author: author, recipient: recipient)
+```
+
+
+### Scoreboards
+
+Fetch scoreboards for the namespace
+
+```ruby
+client.scoreboards
+```
+
+
+### Ratings
+
+Lookup ratings for an author in the namespace
+
+```ruby
+author = Unloq::Author.new(id: 12, type: 'User')
+
+client.lookup_author_ratings(author)
+```
+
 
 ## Documentation
 

data/lib/unloq.rb

@@ -5,9 +5,12 @@ require 'faraday_middleware'
 #Unloq Classes
 require 'unloq/version'
 require 'unloq/api_error'
+require 'unloq/api_error/not_found_error'
 require 'unloq/entity'
 require 'unloq/entities/author'
 require 'unloq/entities/recipient'
 require 'unloq/events'
 require 'unloq/achievements'
+require 'unloq/scoreboards'
+require 'unloq/ratings'
 require 'unloq/client'

data/lib/unloq/api_error/not_found_error.rb

@@ -0,0 +1,4 @@
+module Unloq
+  class APIError::NotFoundError < Unloq::APIError
+  end
+end

data/lib/unloq/client.rb

@@ -3,6 +3,8 @@ module Unloq
 
     include Events
     include Achievements
+    include Scoreboards
+    include Ratings
 
     attr_reader :api_key, :namespace
 
@@ -36,6 +38,20 @@ module Unloq
       format_response_or_raise_error(response)
     end
 
+    # Make a get request to the Unloq API
+    #
+    # @param base_endpoint [String] The base resource endpoint, e.g. /events
+    # @param resource_scope [String] The scope of the resource endpoint, e.g. /User/1/login/User/1
+
+    def get base_endpoint, resource_scope = nil
+
+      response = connection.get do |req|
+        req.url "#{base_endpoint}/#{api_key}/#{namespace}#{resource_scope}"
+      end
+
+      format_response_or_raise_error(response)
+    end
+
 
     # Validate that any author used is of the appropriate type
     def validate_author author
@@ -67,6 +83,8 @@ module Unloq
     def format_response_or_raise_error response
       if response.status / 100 == 2
         response.body
+      elsif response.status == 404
+        raise Unloq::APIError::NotFoundError.new(response.status, response.body)
       else
         raise Unloq::APIError.new(response.status, response.body)
       end

data/lib/unloq/events.rb

@@ -24,5 +24,18 @@ module Unloq
       post('/events', body_to_post)
     end
 
+    # Lookup an event via the Unloq API
+    #
+    # @param author [Unloq::Entity] Author of the event you want to look up
+    # @param verb [String] Verb of the event you want to look up
+    # @param recipient [Unloq::Entity] Recipient of the event you want to look up
+
+    def lookup_event author, verb, recipient
+      validate_author(author)
+      validate_recipient(recipient)
+
+      get('/events', "/#{author.type}/#{author.id}/#{verb}/#{recipient.type}/#{recipient.id}")
+    end
+
   end
 end

data/lib/unloq/ratings.rb

@@ -0,0 +1,15 @@
+module Unloq
+  module Ratings
+
+    # Fetch the ratings for an author
+    #
+    # @param author [Unloq::Entity] The author for which you want to retrieve ratings
+
+    def lookup_author_ratings author
+      validate_author(author)
+
+      get('/ratings', "/#{author.id}")
+    end
+
+  end
+end

data/lib/unloq/scoreboards.rb

@@ -0,0 +1,11 @@
+module Unloq
+  module Scoreboards
+
+    # View scoreboards
+
+    def scoreboards
+      get('/scoreboards')
+    end
+
+  end
+end

data/lib/unloq/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unloq
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Matt Mueller
@@ -135,11 +135,14 @@ files:
 - lib/unloq.rb
 - lib/unloq/achievements.rb
 - lib/unloq/api_error.rb
+- lib/unloq/api_error/not_found_error.rb
 - lib/unloq/client.rb
 - lib/unloq/entities/author.rb
 - lib/unloq/entities/recipient.rb
 - lib/unloq/entity.rb
 - lib/unloq/events.rb
+- lib/unloq/ratings.rb
+- lib/unloq/scoreboards.rb
 - lib/unloq/version.rb
 homepage: http://github.com/mattmueller/unloq
 licenses: