quill-api-client 0.1.6 → 0.2.0

data/lib/quill.rb

@@ -6,6 +6,7 @@ module Quill
   autoload :BaseModel,           'quill/base_model'
   autoload :Client,              'quill/client'
   autoload :Configuration,       'quill/configuration'
+  autoload :Endpoint,            'quill/endpoints'
   autoload :EndpointDefinitions, 'quill/endpoint_definitions'
   autoload :Oauth,               'quill/oauth'
 

data/lib/quill/client.rb

@@ -40,45 +40,5 @@ module Quill
       raise response.error if response.status == 401
       response
     end
-
-    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 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 update id, params
-          check_keys(params)
-          response = api.put([name,id].join('/'), params)
-          Hashie::Mash.new(response.body['object'])
-        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?
-        end
-      end
-    end
   end
-
 end

data/lib/quill/endpoint_base.rb

@@ -0,0 +1,41 @@
+module Quill
+  module Endpoint
+    class Base
+      attr_accessor :name, :api
+      class InvalidKeys < Exception ; 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 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 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?
+      end
+    end
+  end
+end

data/lib/quill/endpoint_definitions.rb

@@ -1,20 +1,22 @@
+require 'quill/endpoints'
+
 module Quill
   module EndpointDefinitions
   
     def activities
-      Quill::Endpoints::Activities.new(self)
+      Quill::Endpoint::Activities.new(self, 'activities', {"description"=>"\nProgrammatically interact with Activities on Compass. Typically only will\nread individual records from this resource.\n", "attributes"=>{"data"=>{}, "name"=>nil, "description"=>nil}, "access"=>{"list"=>["all"], "read"=>["all"], "update"=>["admin"], "create"=>["admin"], "destroy"=>["owner", "admin"]}, "options"=>{}})
     end
   
     def activity_sessions
-      Quill::Endpoints::ActivitySessions.new(self)
+      Quill::Endpoint::ActivitySessions.new(self, 'activity_sessions', {"description"=>"\nCompass activity sessions are used to store progress information about a\nuser's interaction with an activity. Session's can be created without an\n+access_token+ to allow anonymous access. If you have an ID of an\nanonymous session you should also be able to update it without an\n+access_token+.\n", "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"]}, "options"=>{}})
     end
   
     def me
-      Quill::Endpoints::Me.new(self)
+      Quill::Endpoint::Me.new(self, 'me', {"description"=>"\nRequest information about the current authenticated user based on\n+access_token+.\n", "attributes"=>{"role"=>nil, "name"=>nil, "email"=>nil, "username"=>nil}, "options"=>{"singular"=>true}, "access"=>{"read"=>["all"], "update"=>["owner", "admin"], "create"=>["user"], "destroy"=>["owner", "admin"]}})
     end
   
     def ping
-      Quill::Endpoints::Ping.new(self)
+      Quill::Endpoint::Ping.new(self, 'ping', {"description"=>"Alive check.\n", "attributes"=>{"session_id"=>nil, "status"=>nil}, "options"=>{"singular"=>true}, "access"=>{"read"=>["all"], "update"=>["owner", "admin"], "create"=>["user"], "destroy"=>["owner", "admin"]}})
     end
   
   end

data/lib/quill/endpoints.rb

@@ -1,5 +1,6 @@
 module Quill
   module Endpoint
+    autoload :Base, 'quill/endpoint_base'
   
     class Activities < Base
       # Programmatically interact with Activities on Compass. Typically only will

metadata

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