quill-api-client 0.1.5 → 0.1.6

data/lib/quill/client.rb

@@ -41,40 +41,42 @@ module Quill
       response
     end
 
-    class Endpoint
-      attr_accessor :name, :api
+    module Endpoint
+      class Base
+        attr_accessor :name, :api
 
-      def initialize api, name, definition
-        @api = api
-        @name = name
-        @attributes = definition['attributes'].keys
-        @readonly_attributes = definition['readonly_attributes'].try(:keys) || []
-      end
+        def initialize api, name, definition
+          @api = api
+          @name = name
+          @attributes = definition['attributes'].keys
+          @readonly_attributes = definition['readonly_attributes'].try(:keys) || []
+        end
 
-      def find id, params = {}
-        check_keys(params)
-        response = api.get([name,id].join('/'), params)
-        Hashie::Mash.new(response.body['object'])
-      end
+        def find id, params = {}
+          check_keys(params)
+          response = api.get([name,id].join('/'), params)
+          Hashie::Mash.new(response.body['object'])
+        end
 
-      def create params
-        check_keys(params)
-        response = api.post(name, params)
-        Hashie::Mash.new(response.body['object'])
-      end
+        def create params
+          check_keys(params)
+          response = api.post(name, params)
+          Hashie::Mash.new(response.body['object'])
+        end
 
-      def update id, params
-        check_keys(params)
-        response = api.put([name,id].join('/'), params)
-        Hashie::Mash.new(response.body['object'])
-      end
+        def update id, params
+          check_keys(params)
+          response = api.put([name,id].join('/'), params)
+          Hashie::Mash.new(response.body['object'])
+        end
 
-      def list
-      end
+        def list
+        end
 
-      def check_keys params
-        invalid_keys = params.stringify_keys.keys - @attributes - @readonly_attributes
-        raise InvalidKeys, "Endpoint ##{name} does not support key(s) #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+        def check_keys params
+          invalid_keys = params.stringify_keys.keys - @attributes - @readonly_attributes
+          raise InvalidKeys, "Endpoint ##{name} does not support key(s) #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+        end
       end
     end
   end

data/lib/quill/endpoint_definitions.rb

@@ -2,19 +2,19 @@ module Quill
   module EndpointDefinitions
   
     def activities
-      Client::Endpoint.new(self, "activities", {"attributes"=>{"data"=>{}, "name"=>nil, "description"=>nil}, "access"=>{"list"=>["all"], "read"=>["all"], "update"=>["admin"], "create"=>["admin"], "destroy"=>["owner", "admin"]}})
+      Quill::Endpoints::Activities.new(self)
     end
   
     def activity_sessions
-      Client::Endpoint.new(self, "activity_sessions", {"attributes"=>{"percentage"=>nil, "time_spent"=>nil, "state"=>nil, "completed_at"=>nil, "data"=>{}, "temporary"=>nil, "activity_uid"=>nil, "anonymous"=>nil}, "access"=>{"list"=>["all"], "read"=>["owner"], "update"=>["owner", "admin"], "create"=>["all"], "destroy"=>["owner", "admin"]}})
+      Quill::Endpoints::ActivitySessions.new(self)
     end
   
     def me
-      Client::Endpoint.new(self, "me", {"attributes"=>{"role"=>nil}, "options"=>{"singular"=>true}, "access"=>nil})
+      Quill::Endpoints::Me.new(self)
     end
   
     def ping
-      Client::Endpoint.new(self, "ping", {"attributes"=>{"session_id"=>nil, "status"=>nil}, "options"=>{"singular"=>true}, "access"=>{"read"=>["all"], "update"=>["owner", "admin"], "create"=>["user"], "destroy"=>["owner", "admin"]}})
+      Quill::Endpoints::Ping.new(self)
     end
   
   end

data/lib/quill/endpoints.rb

@@ -0,0 +1,88 @@
+module Quill
+  module Endpoint
+  
+    class Activities < Base
+      # Programmatically interact with Activities on Compass. Typically only will
+      # read individual records from this resource.
+      # @param id [String] the id of the Activity
+      def find *args
+        super
+      end
+
+      # Programmatically interact with Activities on Compass. Typically only will
+      # read individual records from this resource.
+      # @param [Hash] properties properties for create
+      # @option properties [String] :data
+      # @option properties [String] :name
+      # @option properties [String] :description
+      def create *args
+        super
+      end
+    end
+  
+    class ActivitySessions < Base
+      # Compass activity sessions are used to store progress information about a
+      # user's interaction with an activity. Session's can be created without an
+      # +access_token+ to allow anonymous access. If you have an ID of an
+      # anonymous session you should also be able to update it without an
+      # +access_token+.
+      # @param id [String] the id of the Activity session
+      def find *args
+        super
+      end
+
+      # Compass activity sessions are used to store progress information about a
+      # user's interaction with an activity. Session's can be created without an
+      # +access_token+ to allow anonymous access. If you have an ID of an
+      # anonymous session you should also be able to update it without an
+      # +access_token+.
+      # @param [Hash] properties properties for create
+      # @option properties [String] :percentage
+      # @option properties [String] :time_spent
+      # @option properties [String] :state
+      # @option properties [String] :completed_at
+      # @option properties [String] :data
+      # @option properties [String] :temporary
+      # @option properties [String] :activity_uid
+      # @option properties [String] :anonymous
+      def create *args
+        super
+      end
+    end
+  
+    class Me < Base
+      # Request information about the current authenticated user based on
+      # +access_token+.
+      def find *args
+        super
+      end
+
+      # Request information about the current authenticated user based on
+      # +access_token+.
+      # @param [Hash] properties properties for create
+      # @option properties [String] :role
+      # @option properties [String] :name
+      # @option properties [String] :email
+      # @option properties [String] :username
+      def create *args
+        super
+      end
+    end
+  
+    class Ping < Base
+      # Alive check.
+      def find *args
+        super
+      end
+
+      # Alive check.
+      # @param [Hash] properties properties for create
+      # @option properties [String] :session_id
+      # @option properties [String] :status
+      def create *args
+        super
+      end
+    end
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quill-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &70182730883920 !ruby/object:Gem::Requirement
+  requirement: &70335961783660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70182730883920
+  version_requirements: *70335961783660
 description: Wrapper to Quill API
 email: quinn@tastehoneyco.com
 executables: []
@@ -34,6 +34,7 @@ files:
 - lib/quill/client.rb
 - lib/quill/configuration.rb
 - lib/quill/endpoint_definitions.rb
+- lib/quill/endpoints.rb
 - lib/quill/oauth.rb
 - lib/quill-api-client.rb
 - lib/quill.rb