zenbe-flareshow 0.2.4 → 0.3.0

data/Flareshow.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flareshow}
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Bailey"]
-  s.date = %q{2009-09-11}
-  s.description = %q{TODO: a ruby gem for interacting with the shareflow collaboration service by Zenbe}
+  s.date = %q{2009-09-12}
+  s.description = %q{a ruby gem for interacting with the shareflow collaboration service by Zenbe}
   s.email = %q{will.bailey@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -30,8 +30,10 @@ Gem::Specification.new do |s|
      "lib/file_attachment.rb",
      "lib/flareshow.rb",
      "lib/flow.rb",
+     "lib/http_encoding_helper.rb",
      "lib/invitation.rb",
      "lib/membership.rb",
+     "lib/mime_parts.rb",
      "lib/post.rb",
      "lib/resource.rb",
      "lib/searchable.rb",
@@ -46,8 +48,8 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{flareshow}
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{TODO: a ruby gem for interacting with the shareflow collaboration service}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{a ruby gem for interacting with the shareflow collaboration service}
   s.test_files = [
     "test/flareshow_test.rb",
      "test/test_helper.rb"

data/README.md

@@ -91,7 +91,7 @@ Flareshow offers an ActiveRecord like syntax for retrieving and manipulating mod
     f.name = 'a different name'
     f.save
 
-### Inviting someone to a flow (only available if you are the creator of the flow)
+#### inviting someone to a flow (only available if you are the creator of the flow)
 
     f=Flow.find_by_name('test')
     f.send_invitations('test@test.com')
@@ -99,21 +99,21 @@ Flareshow offers an ActiveRecord like syntax for retrieving and manipulating mod
     # this also works
     f.send_invitations(['test1@test.com', 'test2@test.com'])
     
-### Canceling an invitation to a flow (only available if you are the creator of the flow)
+#### canceling an invitation to a flow (only available if you are the creator of the flow)
     
     f=Flow.find_by_name('test')
     # revoke an invitation by the email address that was invited
     f.revoke_invitations('test@test.com')
 
 
-### Removing a user from a flow (only available if you are the creator of the flow)
+#### removing a user from a flow (only available if you are the creator of the flow)
 
     f = Flow.find_by_name('test')
     users = f.list_users # get a listing of the users on the flow
     # remove the last user in the list from the flow...you cant remove yourself in this way
     f.remove_members(users.last.id) 
 
-### listing all the users on a flow
+#### listing all the users on a flow
 
     f=Flow.first
     f.list_users

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/lib/flareshow.rb

@@ -3,16 +3,19 @@ ROOT = File.dirname(__FILE__) unless defined? ROOT
 # gems
 require 'rubygems' #TODO fix
 require 'json'
-require 'curb'
 require 'facets'
 require 'facets/dictionary'
 require 'uuid'
-require 'ruby-debug'
+require 'mime/types'
+require 'cgi'
 
 # std lib
+require 'net/http'
+require 'net/https'
 require 'ostruct'
 require 'yaml'
 require 'logger'
+require 'ruby-debug'
 
 # Application Constants and configuration
 module Flareshow
@@ -47,6 +50,7 @@ Dir.glob(File.join(ROOT, "*.rb")).each{|lib| require lib}
 config_file_path = File.expand_path("~/.flareshowrc")
 if File.exists?(config_file_path) && !Flareshow::Service.authenticated?
   data = YAML.load_file(config_file_path)
+  Flareshow::Service.debug_output=true if data["debug_http"]
   host = data["host"] || "biz.zenbe.com"
   subdomain = data["subdomain"]
   DEFAULT_LOGGER.level = data["log_level"].to_i if data["log_level"]

data/lib/http_encoding_helper.rb

@@ -0,0 +1,49 @@
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"  
+# end
+#	
+
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+    encoding=self['content-encoding']
+    content=nil
+    if encoding then
+      case encoding
+        when 'gzip'
+          i=Zlib::GzipReader.new(StringIO.new(self.body))
+          content=i.read
+        when 'deflate'
+          i=Zlib::Inflate.new
+          content=i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      content=self.body
+    end
+    return content
+  end
+end

data/lib/mime_parts.rb

@@ -0,0 +1,37 @@
+# Adapted From : http://deftcode.com/code/flickr_upload/multipartpost.rb
+
+class Param
+  attr_accessor :key, :value, :content_type
+  def initialize(key, value, content_type)
+    @key = key; @value = value; @content_type = content_type
+  end
+  
+  def to_multipart
+    return "\r\nContent-Disposition: form-data; name=\"#{CGI::escape(key)}\"\r\n" +
+"Content-Type: #{content_type}; charset=UTF-8" +
+"\r\n\r\n#{value}\r\n"
+  end
+end
+  
+class FileParam
+  attr_accessor :key, :filename, :content
+  def initialize( key, filename, content )
+    @key = key; @filename = filename; @content = content
+  end
+  
+  def to_multipart
+    return "Content-Disposition: form-data; name=\"#{CGI::escape(key)}\"; filename=\"#{filename}\"\r\n" +
+"Content-Transfer-Encoding: binary\r\n" +
+"Content-type: #{MIME::Types.type_for(filename)}\r\n\r\n" + content + "\r\n"
+  end
+end
+
+class MultipartPost
+  BOUNDARY = "flareshow_multipart_boundary_A0n23hja"
+  HEADER = {"Content-type" => "multipart/form-data, boundary=" + BOUNDARY + " "}
+
+  def self.prepare_query(params)
+    query = params.map {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
+    [query, HEADER]
+  end
+end

data/lib/resource.rb

@@ -97,6 +97,7 @@ class Flareshow::Resource
     self
   rescue Exception => e
     Flareshow::Util.log_error e.message
+    Flareshow::Util.log_error e.backtrace.join("\n")
     throw e
     false
   end

data/lib/service.rb

@@ -5,22 +5,23 @@ class Flareshow::Service
   # = Class Methods =
   # =================
   class << self
-    attr_accessor :server
+    attr_accessor :server, :debug_output, :key
     
     # setup the service to use a particular host and domain
     def configure(subdomain=nil, host='api.zenbe.com')
       raise Flareshow::ConfigurationException unless subdomain
       self.server=Server.new(host, subdomain)
+      @auth_endpoint = @api_endpoint = nil
     end
     
     # return the authentication endpoint for a given host and domain
     def auth_endpoint
-      "http://#{server.host}/#{server.domain}/shareflow/api/v2/auth.json"
+      @auth_endpoint ||= URI.parse("http://#{server.host}/#{server.domain}/shareflow/api/v2/auth.json")
     end
     
     # return the api endpoint for a given host and domain
     def api_endpoint
-      "http://#{server.host}/#{server.domain}/shareflow/api/v2.json"
+      @api_endpoint ||= URI.parse("http://#{server.host}/#{server.domain}/shareflow/api/v2.json")
     end
     
     # has the server been configured?
@@ -33,73 +34,74 @@ class Flareshow::Service
     #  - status code
     #  - headers
     #  - body
-    def post(url, params)
+    def post(uri, params, files=[])
       raise Flareshow::ConfigurationException unless server_defined?
-      request = Curl::Easy.new(url) do |curl|
-        curl.headers = {
-          'Accept'        => 'application/json',
-          'User-Agent'    => 'flareshow 0.1'
-        }
-        curl.multipart_form_post=true
-      end
-      request.http_post(*params)
-      response = process_response(request)
+      # create the request object
+      req = Net::HTTP::Post.new(uri.path)
+      # set request headers
+      req.add_field "Accept", "application/json"
+      req.add_field "User-Agent", "ruby flareshow"
+      req.add_field "Accept-Encoding", "compress, gzip"
 
-      # log a service exception
-      case response["status_code"]
-        when 400
-          log_service_error(response)
-        when 500
-          log_service_error(response)
-        when 403
-          log_service_error(response)
-      end
-        
-      response
-    end
-    
-    # do a get request
-    def http_get(url)
-      request = Curl::Easy.new(url + "?key=#{@key}") do |curl|
-        curl.headers = {
-          'User-Agent'    => 'flareshow 0.1'
+      # just json
+      if !files || files.empty?
+        req.add_field "Content-type", "application/json; charset=UTF-8"
+        # set the postbody
+        req.body = params.to_json
+      # handle file params
+      else
+        params = params.map{|p| 
+          val = p[1].is_a?(String) ? p[1] : p[1].to_json
+          Param.new(p[0], val, "application/json")
         }
+        files.each do |f|
+          params << FileParam.new(f["part_id"], f["file_path"], File.read(f["file_path"]))
+        end
+        body, header = *MultipartPost.prepare_query(params)
+        req.add_field "Content-type", header["Content-type"]
+        req.body = body
       end
-      request.perform()
-      response = process_response(request)
       
-      Flareshow::Util.log_error("resource not found") if response["status_code"] == 404
+      # make the request
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.set_debug_output DEFAULT_LOGGER if debug_output
+      response = http.start {|h| h.request(req)}
       
+      # normalize the response
+      response = process_response(response)
+      log_response(response)
       response
     end
     
-    # get the interesting bits out of the curl response
-    def process_response(request)
-      response = {"status_code" => request.response_code, "headers" => request.header_str, "body" => request.body_str}
-      if (/json/i).match(request.content_type)
-        response["resources"] = JSON.parse(response["body"])
-      end
-      Flareshow::Util.log_info(response["status_code"])
-      Flareshow::Util.log_info(response["body"])
+    # do a get request
+    def http_get(uri)
+      uri = URI.parse(uri) unless uri.is_a? URI
+      req = Net::HTTP::Get.new(uri.path + "?key=#{@key}")
+      req.add_field "User-Agent", "ruby flareshow"
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.set_debug_output DEFAULT_LOGGER if debug_output
+      response = http.start{|h|http.request(req)}
+      response = process_response(response)
+      Flareshow::Util.log_error("resource not found") if response["status_code"] == 404
       response
     end
     
-    # log a service error
-    def log_service_error(response)
-      if response["resources"]
-        Flareshow::Util.log_error(response["resources"]["message"])
-        Flareshow::Util.log_error(response["resources"]["details"]) 
-      else
-        Flareshow::Util.log_error(response["body"])
+    # log the response
+    def log_response(response)
+      # log a service exception
+      case response["status_code"]
+        when 400
+          log_service_error(response)
+        when 500
+          log_service_error(response)
+        when 403
+          log_service_error(response)
       end
     end
     
     # authenticate with the server using an http post
     def authenticate(login, password)
-      params = [
-        Curl::PostField.content("login", login),
-        Curl::PostField.content("password", password)
-      ]
+      params = {:login => login, :password => password}
       response = post(auth_endpoint, params)
       # store the auth token returned from the authentication request
       if response["status_code"] == 200
@@ -110,59 +112,82 @@ class Flareshow::Service
       end
     rescue Exception => e
       Flareshow::Util.log_error e.message
-    end
-    
-    # clear the authenticated session
-    def logout
-      @key = nil
-    end
-    
-    # are we authenticated
-    def authenticated?
-      !!@key
+      Flareshow::Util.log_error e.backtrace.join("\n")
     end
     
     # query the server with an http post of the query params
     def query(params={})
       raise Flareshow::AuthenticationRequired unless @key
-
-      # add the json request parts
-      params = [
-        Curl::PostField.content("key", @key, 'application/json'),
-        Curl::PostField.content("query", params.to_json, 'application/json')
-      ]
-      
+      params = {"key" => @key, "query" => params}
       post(api_endpoint, params)
     end
     
     # commit changes to the server with an http post
     def commit(params={}, files=[])
       raise Flareshow::AuthenticationRequired unless @key
-
-      curl_params = []
-      has_files = false
-      if params["posts"]
-        # add any file parts passed in and assign a part id to the 
-        params["posts"] = (params["posts"]).map do |f|
-          if f["files"]
-            f["files"] = (f["files"]).each do |ff|
-              has_files = true
-              curl_params.push(Curl::PostField.file(ff["part_id"], ff["file_path"]))
+      params, files = *files_from_params(params) if params["posts"]
+      params = {"key" => @key, "data" => params}
+      post(api_endpoint, params, files)
+    end
+    
+    # get the files out of the params
+    def files_from_params(params)
+      files = []
+      # add any file parts passed in and assign a part id to the 
+      params["posts"] = (params["posts"]).map do |f|
+        if f["files"]
+          f["files"] = (f["files"]).map do |ff|
+            # we only want to send up new files from the client so we'll strip out any existing
+            # files in the params that came down from the server
+            val = nil
+            if ff["part_id"]
+              val = {"part_id" => ff["part_id"], "file_path" => ff["file_path"]} 
+              files << val
             end
-          end
-          f
+            val
+          end.compact
         end
+        f
       end
+      [params, files]
+    end
+    
+    # get the interesting bits out of the curl response
+    def process_response(response)
+      # read the response headers
+      headers = {}; response.each_header{|k,v| headers[k] = v}
+      # build a response object
+      response_obj = {"status_code" => response.code.to_i, "headers" => headers, "body" => response.plain_body}
       
-      params["files"] = []
-      
-      # add the json request parts
-      curl_params += [
-        Curl::PostField.content("key", @key, 'application/json'),
-        Curl::PostField.content("data", params.to_json, 'application/json')
-      ]
+      # automatically handle json response
+      if (/json/i).match(response.content_type)
+        response_obj["resources"] = JSON.parse(response_obj["body"])
+      end
       
-      post(api_endpoint, curl_params)
+      # log the response
+      Flareshow::Util.log_info(response_obj["status_code"])
+      Flareshow::Util.log_info(response_obj["body"])
+      response_obj
+    end
+    
+    # log a service error
+    def log_service_error(response)
+      if response["resources"]
+        Flareshow::Util.log_error(response["resources"]["message"])
+        Flareshow::Util.log_error(response["resources"]["details"]) 
+      else
+        Flareshow::Util.log_error(response["body"])
+      end
+    end
+    
+    # clear the authenticated session
+    def logout
+      @key = nil
+    end
+    
+    # are we authenticated
+    def authenticated?
+      !!@key
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zenbe-flareshow
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Will Bailey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-11 00:00:00 -07:00
+date: 2009-09-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +72,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "TODO: a ruby gem for interacting with the shareflow collaboration service by Zenbe"
+description: a ruby gem for interacting with the shareflow collaboration service by Zenbe
 email: will.bailey@gmail.com
 executables: []
 
@@ -95,8 +95,10 @@ files:
 - lib/file_attachment.rb
 - lib/flareshow.rb
 - lib/flow.rb
+- lib/http_encoding_helper.rb
 - lib/invitation.rb
 - lib/membership.rb
+- lib/mime_parts.rb
 - lib/post.rb
 - lib/resource.rb
 - lib/searchable.rb
@@ -131,7 +133,7 @@ rubyforge_project: flareshow
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: "TODO: a ruby gem for interacting with the shareflow collaboration service"
+summary: a ruby gem for interacting with the shareflow collaboration service
 test_files: 
 - test/flareshow_test.rb
 - test/test_helper.rb