zenbe-flareshow 0.2.1 → 0.2.2

data/Flareshow.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flareshow}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Bailey"]
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "lib/membership.rb",
      "lib/post.rb",
      "lib/resource.rb",
+     "lib/searchable.rb",
      "lib/server.rb",
      "lib/service.rb",
      "lib/user.rb",

data/README.txt

@@ -6,4 +6,65 @@
   \ \_\   /\____\ \__/.\_\\ \_\\ \____\/\____/ \ \_\ \_\ \____/\ \___x___/'
    \/_/   \/____/\/__/\/_/ \/_/ \/____/\/___/   \/_/\/_/\/___/  \/__//__/
    
-   ~ Client Library For the Zenbe Shareflow API
+   ~ Client Library For the Zenbe Shareflow API
+
+== OVERVIEW
+
+Flareshow provides a ruby wrapper around the shareflow json rpc wire protocol.  For more information about the Shareflow API see:
+<Shareflow API Docs Link>
+   
+== AUTHENTICATION
+   
+All actions in Flareshow require authenticationFlareshow can automatically authenticate you against your shareflow server.  Just create a YAML formatted .flareshowrc file in your home directory with the following keys
+
+subdomain : demo.zenbe.com
+login     : demo
+password  : password
+
+To authenticate manually do the following:
+
+Flareshow::Service.configure(<subdomain>)
+Flareshow.authenticate(<login>, <password>)
+
+== USAGE
+
+Once you've authenticated you can choose to use either interact directly with the Flareshow::Service or use the Flareshow::Resource domain models which encapsulate the domain logic of Shareflow providing a friendlier development environment.
+
+== EXAMPLES
+
+= Reading Posts
+
+# the following code will read all posts on the server in a loop
+
+per_request = 30 # 30 is the default returned by the server -- max is 100
+results = []
+loop do 
+  offset ||= 0
+  results << Post.find(:offset => offset, :limit => per_request)
+  offset += per_request
+end
+
+= Upload a file to a Post
+p=Post.new()
+p.save
+p.create_file("/path/to/your/file")
+
+= Searching for a post
+
+# posts, files, comments include the searchable mixin
+# and can be searched using full text search capabilities
+# on the server
+results = Post.search("some keywords")
+
+= deleting a post or comment
+Post.find(:limit => 1).first.destroy
+Comment.find(:limit => 1).first.destroy
+
+= Renaming a flow
+f=Flow.find_by_name('test')
+f.name = 'a different name'
+f.save
+
+== Caching
+
+If you choose to use the Flareshow::Resource objects to manage requests through the Service a caching layer is built in.  Currently this cache is in memory only; however, the API is designed to allow developers to plugin alternate caches as desired.  For example if you wanted to persist shareflow data in a sql lite database you just need to create a SQLLite cache class implementing the Flareshow cache interface.

data/TODO

@@ -1,4 +1,5 @@
 TODO:
+shareflow api docs
 write tests with Fakeweb
 flesh out more resource methods
 make post requests with embedded file attachments respond with the file attachments for now...later we need to allow the creation of files in the same way as posts as flat 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/cache.rb

@@ -7,20 +7,25 @@ class Flareshow::CacheManager
     def assimilate_resources(data)
       # process each resource key and generate a new object
       # or merge the object data with an existing object
-      data.each do |resource_pair|
+      data.inject({}) do |memo,resource_pair|
         resource_key, resources = resource_pair[0], resource_pair[1]
+        
+        fs_resource_array = memo[resource_key] ||= []
+        
         klass = Kernel.const_get(Flareshow::ResourceToClassMap[resource_key])
-        next unless klass
-        resources = resources.map do |resource_data|
-          item = cache.get_resource(resource_key, resource_data["id"])
-          if item
-            item.update(resource_data, :server)
-          else
-            item = klass.new(resource_data, :server) 
+        if klass
+          resources.each do |resource_data|
+            item = cache.get_resource(resource_key, resource_data["id"])
+            if item
+              item.update(resource_data, :server)
+            else
+              item = klass.new(resource_data, :server) 
+            end
+            cache.set_resource(resource_key, item.id, item)
+            fs_resource_array << item
           end
-          cache.set_resource(resource_key, item.id, item)
-          item
         end
+        memo
       end
     end
     
@@ -47,6 +52,10 @@ class Flareshow::Cache
       resource_cache(resource_key)[id] = object
     end
     
+    def list_resource(resource_key)
+      resource_cache(resource_key)
+    end
+    
     # remove all cached objects
     def flush
       data = {}
@@ -58,6 +67,7 @@ class Flareshow::Cache
     end
     
     private
+    # data store for the cache
     def data
       @cache ||= {}
     end

data/lib/comment.rb

@@ -1,5 +1,7 @@
 class Comment < Flareshow::Resource
   
+  extend Flareshow::Searchable
+  
   # permalink to this comment
   def permalink(mobile=false)
     if mobile

data/lib/file_attachment.rb

@@ -1,5 +1,7 @@
 class FileAttachment < Flareshow::Resource
   
+  extend Flareshow::Searchable
+  
   # =================
   # = Class Methods =
   # =================

data/lib/flareshow.rb

@@ -39,6 +39,7 @@ end
 require File.join(ROOT, 'service')
 require File.join(ROOT, 'resource')
 require File.join(ROOT, 'cache')
+require File.join(ROOT, 'searchable')
 
 # logging
 DEFAULT_LOGGER = Logger.new(STDOUT) unless defined?(DEFAULT_LOGGER)

data/lib/flow.rb

@@ -13,9 +13,9 @@ class Flow < Flareshow::Resource
   # permalink for this flow
   def permalink(mobile=false)
     if mobile
-      "http://#{Flareshow::Base.server.host}/#{Flareshow::Base.server.domain}/shareflow/mobile/flows/#{id}"
+      "http://#{Flareshow::Service.server.host}/#{Flareshow::Service.server.domain}/shareflow/mobile/flows/#{id}"
     else
-      "http://#{Flareshow::Base.server.host}/#{Flareshow::Base.server.domain}/shareflow/c/#{id}"
+      "http://#{Flareshow::Service.server.host}/#{Flareshow::Service.server.domain}/shareflow/c/#{id}"
     end
   end
   

data/lib/post.rb

@@ -1,11 +1,13 @@
 class Post < Flareshow::Resource
   
+  extend Flareshow::Searchable
+  
   # permalink to this post
   def permalink(mobile=false)
     if mobile
-      "http://#{Flareshow::Base.server.host}/#{Flareshow::Base.server.domain}/shareflow/mobile/post/#{id}"
+      "http://#{Flareshow::Service.server.host}/#{Flareshow::Service.server.domain}/shareflow/mobile/post/#{id}"
     else
-      "http://#{Flareshow::Base.server.host}/#{Flareshow::Base.server.domain}/shareflow/p/#{id}"
+      "http://#{Flareshow::Service.server.host}/#{Flareshow::Service.server.domain}/shareflow/p/#{id}"
     end
   end
   

data/lib/resource.rb

@@ -1,6 +1,8 @@
 class Flareshow::Resource
   
   class << self
+    attr_accessor :read_only, :attr_accessible
+    
     # return the resource key for this resource
     def resource_key
       Flareshow::ClassToResourceMap[self.name]
@@ -26,10 +28,9 @@ class Flareshow::Resource
     # the keyed resources for the model performing the query
     def find(params={})
       response = Flareshow::Service.query({resource_key => params})
-      cache_response(response)
-      (response["resources"] || {})[resource_key]
+      (cache_response(response) || {})[resource_key]
     end
-
+    
     # create a resource local and sync it to the server
     def create(params={})
       new(params).save
@@ -80,7 +81,7 @@ class Flareshow::Resource
   
   # destroy the resource on the server
   def destroy
-    response = self.class.commit({resource_key => [{"id" => id, "_removed" => true}]})
+    response = Flareshow::Service.commit({resource_key => [{"id" => id, "_removed" => true}]})
     cache_response(response)
     mark_destroyed!
     self
@@ -93,6 +94,7 @@ class Flareshow::Resource
   
   private
   
+  # clear the element of the cache
   def mark_destroyed!
     self.freeze
     self._removed=true 

data/lib/searchable.rb

@@ -0,0 +1,9 @@
+module Flareshow
+  module Searchable
+  
+      def search(keywords)
+        self.find({:keywords => keywords})
+      end
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zenbe-flareshow
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Will Bailey
@@ -99,6 +99,7 @@ files:
 - lib/membership.rb
 - lib/post.rb
 - lib/resource.rb
+- lib/searchable.rb
 - lib/server.rb
 - lib/service.rb
 - lib/user.rb