quill-api-client 0.0.1

data/lib/quill/activity_model.rb

@@ -0,0 +1,32 @@
+class Quill::ActivityModel < Quill::BaseModel
+  include ActiveModel::Model
+
+  special_attrs :name, :description
+
+  def self.key_attributes
+    [:_cid, :_uid]
+  end
+
+  def filter_params params
+    params[:cid] = _cid
+    params[:data].delete(:_cid)
+    params[:data].delete(:_uid)
+    params
+  end
+
+  def key_present?
+     _cid.present? && _uid.present?
+   end
+
+  def find
+    api.activities.find(_uid, cid: _cid)
+  end
+
+  def persist_params params
+    if _uid.present?
+      api.activities.update(_uid, params)
+    else
+      api.activities.create(params)
+    end
+  end
+end

data/lib/quill/activity_session.rb

@@ -0,0 +1,23 @@
+class Quill::ActivitySession < Quill::BaseModel
+  special_attrs :percentage, :time_spent, :state, :completed_at, :activity_uid, :anonymous
+
+  def find
+    if anonymous && _uid.blank?
+      persist
+    else
+      api.activity_sessions.find(_uid)
+    end
+  end
+
+  def activity(cid)
+    raise if activity_uid.blank?
+    return nil if activity_uid.blank?
+    return @activity if @activity.present?
+    @activity = Story.new(_uid: activity_uid, _cid: cid)
+  end
+
+  def key_present?
+    return true if anonymous
+    super
+  end
+end

data/lib/quill/base_model.rb

@@ -0,0 +1,111 @@
+class Quill::BaseModel
+  include ActiveModel::Model
+
+  def self.special_attrs *attrs
+    return @special_attrs unless attrs.any?
+    @special_attrs = attrs
+  end
+
+  def self.inherited subclass
+    subclass.special_attrs *@special_attrs
+  end
+
+  def self.attributes *attrs
+    return @attributes if defined?(@attributes)
+    @attributes = attrs
+
+    (attrs.dup.unshift(*@special_attrs).unshift(*key_attributes)).each do |attr|
+      class_eval <<-CODE
+        def #{attr}
+          @data[:#{attr}]
+        end
+
+        def #{attr}= value
+          @data[:#{attr}] = value
+        end
+      CODE
+    end
+  end
+
+  def self.key_attributes
+    [:_uid]
+  end
+
+  def initialize *args
+    @data = {}
+    super
+    load_model_attributes
+  end
+
+  def save(options={})
+    perform_validations(options) ? persist : false
+  end
+
+  def persist
+    data = @data.except(*self.class.special_attrs.dup << :_uid)
+    serialized_data = {}
+
+    data.each do |key, value|
+      serialized_data[key] = value.to_yaml
+    end
+
+    params = { data: serialized_data }
+
+    self.class.special_attrs.each do |attr|
+      params[attr] = send(attr)
+    end
+
+    params = filter_params(params) if respond_to?(:filter_params)
+    persist_params params
+  end
+
+  def load_model_attributes
+    return unless key_present?
+
+    object = find
+    object.data = {} if object.data.nil?
+    attrs = {}
+
+    attrs[:_uid] = object.uid
+
+    # load attributes defined on the superclass. These attributes
+    # are designated by Quill.
+    self.class.special_attrs.each do |attr|
+      attrs[attr] = object.send(attr)
+    end
+
+    # load user defined attributes. This is arbitrary data that the app
+    # has stored for this record.
+    self.class.attributes.each do |attr|
+      attrs[attr] = YAML.load(object.data[attr]) if object.data[attr].present?
+    end
+
+    @data.reverse_merge!(attrs)
+  end
+
+  def save!
+    save || raise
+  end
+
+protected
+
+  def key_present?
+     _uid.present?
+  end
+
+  def persist_params params
+    if _uid.present?
+      api.activity_sessions.update(_uid, params)
+    else
+      api.activity_sessions.create(params)
+    end
+  end
+
+  def api
+    @api ||= Quill::Client.new
+  end
+
+  def perform_validations(options={})
+    options[:validate] == false || valid?(options[:context])
+  end
+end

data/lib/quill/client.rb

@@ -0,0 +1,60 @@
+class Quill::Client
+  class InvalidKeys < Exception ; end
+  delegate :get, :post, :put, to: :connection
+
+  
+    def activities
+      Endpoint.new(self, "activities", {"attributes"=>{"data"=>{}, "name"=>nil, "description"=>nil}, "readonly_attributes"=>{"cid"=>nil}})
+    end
+  
+    def activity_sessions
+      Endpoint.new(self, "activity_sessions", {"attributes"=>{"percentage"=>nil, "time_spent"=>nil, "state"=>nil, "completed_at"=>nil, "data"=>{}, "temporary"=>nil, "activity_uid"=>nil}, "readonly_attributes"=>{"anonymous"=>nil}})
+    end
+  
+
+  def connection
+    Faraday.new(url: ENV['QUILL_API_URL']) do |conn|
+      conn.request :json
+      conn.response :json
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  class Endpoint
+    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
+      # raise @readonly_attributes.inspect
+      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

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: quill-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Quinn Shanahan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper to Quill API
+email: quinn@tastehoneyco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/quill/activity_model.rb
+- lib/quill/activity_session.rb
+- lib/quill/base_model.rb
+- lib/quill/client.rb
+homepage: https://github.com/empirical/quill-platform
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Wrapper to Quill API
+test_files: []
+has_rdoc: