aproxacs-storyq_client 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-07-09
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+lib/storyq_client.rb
+lib/storyq_client/base.rb
+lib/storyq_client/box.rb
+lib/storyq_client/photo.rb
+lib/storyq_client/resource.rb
+lib/storyq_client/token.rb
+lib/storyq_client/upload.rb

data/README.txt

@@ -0,0 +1,115 @@
+= storyq_client
+
+* Homepage: http://www.aproxacs.com/166
+* Author: aproxacs
+
+== DESCRIPTION:
+StoryQ client Library
+This library makes it easy to use storyq's Open API. 
+You can easily upload documents and photos to the storyq and convert them to the flash slide with this library. 
+This follows the restful style but not uses active_resource.
+
+This is mainly refered to the active_resource and springnote_client gem.
+Specially thanks to the springnote_client.
+
+== FEATURES/PROBLEMS:
+
+
+== SYNOPSIS:
+
+# create a storyq instance
+storyq = Storyq(
+  :consumer_token => "CONSUMER_TOKEN",
+  :consumer_secret => "CONSUMER_SECRET",
+  :access_key => "ACCESS_TOKEN",
+  :access_secret => "ACCESS_SECRET")
+
+# Get all boxes
+boxes = storyq.boxes.find :all                          # returns 20 recent boxes
+boxes = storyq.boxes.find :all :page => 2               # returns 21-40 boxes 
+boxes = storyq.boxes.find :all :page => 2, :per_page=>3 # returns 21-23 boxes 
+boxes = storyq.slide_boxes.find :all                    # returns 20 recent slide boxes
+boxes = storyq.photo_boxes.find :all                    # returns 20 recent photo boxes
+
+# Get my boxes
+boxes = storyq.boxes.find :mine     # returns 5 boxes belongs to the current authenticated user.
+boxes = storyq.slide_boxes.find :mine
+
+# Get a box
+box = storyq.boxes.find 1234    # returns a box whose id is 1234
+puts box.title
+
+# Update a box
+box.title = "my world"
+box.tags = "some, tags"
+box.save
+
+# Destory a box
+box.destory
+
+# Create a slide box
+storyq.slide_boxes.create(
+    "filename" => "A_FILE.ppt", 
+    "title" => "TITLE", 
+    "description" => "DESCRIPTION", 
+    "tags" => "SOME, TAGS", 
+    "category" => "����", 
+    "permission" => "public")
+
+# Create a photo box
+pbox = storyq.photo_boxes.create( 
+    "title" => "TITLE", 
+    "description" => "DESCRIPTION", 
+    "tags" => "SOME, TAGS", 
+    "category" => "����", 
+    "permission" => "public")
+
+# Add a photo to photo box 
+photo = pbox.add_photo( 
+        "filename" => "A_IMAGE.jpg",
+        "title" => "TITLE",
+        "note" => "SOME NOTES FOR THE PICTURE")
+
+# get photo box's photos
+photos = pbox.photos
+
+# update a photo
+photo.title = "NEW TITLE"
+photo.note = "NEW NOTE"
+photo.save
+
+# delete a photo
+photo.destory
+
+== REQUIREMENTS:
+* active_support
+* oauth
+
+== INSTALL:
+
+* sudo gem install storyq_client
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Bryan Kang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/storyq_client/base.rb

@@ -0,0 +1,63 @@
+require 'storyq_client/upload'
+require 'storyq_client/token'
+require 'storyq_client/resource'
+require 'storyq_client/box'
+require 'storyq_client/photo'
+
+def StoryQ(*params)
+  Storyq::Base.new(*params)
+end
+
+module Storyq
+  class Base    
+    include Token
+    
+    def initialize(config)
+      config[:site] ||= "http://www.storyq.net"
+      self.config = config
+    end
+      
+    def slide_boxes
+      CallProxy.new(SlideBox, self)
+    end
+    def photo_boxes
+      CallProxy.new(PhotoBox, self)
+    end
+    def boxes
+      CallProxy.new(Box, self)
+    end
+      
+    def post url, body, headers={}
+      headers["content-type"] ||= 'application/x-www-form-urlencoded' unless body.blank?
+      access_token.request(:post, url, body, header(headers)).body
+    end
+    def put url, body, headers={}
+      headers["content-type"] ||= 'application/x-www-form-urlencoded' unless body.blank?
+      access_token.request(:put, url, body, header(headers)).body
+    end
+    def delete url, headers={}
+      access_token.request(:delete, url, header(headers)).body
+    end
+    def get url, headers={}
+      access_token.request(:get, url, header(headers)).body
+    end
+    
+    def header headers
+      default_header.merge(headers)
+    end
+    
+    def default_header
+      { "accept" => 'application/xml' }
+    end
+      
+  end
+  
+  class CallProxy
+    def initialize(callee, *params)
+      @callee, @params = callee, params
+    end
+    def method_missing(method, *params, &block)
+      @callee.send(method, *(params+@params), &block)
+    end
+  end
+end

data/lib/storyq_client/box.rb

@@ -0,0 +1,71 @@
+module Storyq
+  class Box < Storyq::Resource
+    class << self
+      def save_params
+        %w(title category description tags permission)
+      end
+      def prefix(type = :url)
+        ""
+      end
+      def collection_name(type = :url)
+        prefix(type) + "boxes"
+      end
+      def singular_name(type = :url)
+        prefix(type) + "box"
+      end
+    end
+  end
+
+  class PhotoBox < Storyq::Box
+    class << self
+      def save_params
+        %w(title category description tags permission bgm_url play_interval play_effect, photo_array)
+      end
+      def prefix(type = :url)
+        type == :url ? "photo_" : ""
+      end
+    end
+    
+    attr_reader :holder
+    def photos
+      Storyq::Photo.instantiate_resources(Hash.from_xml(@holder.get("/photo_boxes/#{id}/photos?")), self)
+    end
+    
+    def add_photo attributes
+      Storyq::Photo.create attributes, self
+    end
+  end
+ 
+  class SlideBox < Storyq::Box
+    include Storyq::Upload
+    
+    class << self
+      def save_params
+        %w(title category description tags permission)
+      end
+      def prefix(type = :url)
+        type == :url ? "slide_" : ""
+      end
+    end
+    
+    def parameters
+      parameters = super
+      if @hash["filename"]
+        parameters["slide_box[uploaded_data]"] = uploaded_file(@hash["filename"])
+      end
+      parameters
+    end
+
+    def save
+      if new?
+        xml = @holder.post("/slide_boxes", multipart_body(parameters, boundary), 
+          "content-type" => "multipart/form-data; boundary=#{boundary}")
+        @hash["filename"] = nil
+      else
+        xml = @holder.put("/slide_boxes/#{id}", parameters.to_query)
+      end
+      @hash = Hash.from_xml(xml)["box"]
+      self
+    end
+  end
+end

data/lib/storyq_client/photo.rb

@@ -0,0 +1,51 @@
+module Storyq
+  class Photo < Storyq::Resource
+    include Storyq::Upload
+    
+    class << self
+      def save_params
+        %w(title note)
+      end
+      
+      def collection_name(type = :url)
+        "photos"
+      end
+      def singular_name(type = :url)
+        "photo"
+      end      
+    end
+
+    def initialize(*args)
+      @photo_box = args.pop
+      @holder = @photo_box.holder
+      @hash = args.shift
+    end
+    
+    def parameters
+      parameters = super
+      if @hash["filename"]
+        parameters["photo[uploaded_data]"] = uploaded_file(@hash["filename"])
+      end
+      parameters
+    end    
+
+    def save
+      if new?
+        p parameters
+        xml = @holder.post("/photo_boxes/#{@photo_box.id}/photos", multipart_body(parameters, boundary), 
+          "content-type" => "multipart/form-data; boundary=#{boundary}")
+        @hash["filename"] = nil
+      else
+        xml = @holder.put("/photo_boxes/#{@photo_box.id}/photos/#{id}", parameters.to_query)
+      end
+      @hash = Hash.from_xml(xml)["photo"]
+      self
+    end
+    
+    def destroy
+      puts "hey"
+      xml = @holder.delete("/photo_boxes/#{@photo_box.id}/photos/#{id}")
+      @hash = Hash.from_xml(xml)
+    end    
+  end
+end

data/lib/storyq_client/resource.rb

@@ -0,0 +1,89 @@
+module Storyq
+  class Resource
+    class << self
+      def instantiate_resource hash, holder
+        new(hash, holder)
+      end
+
+      def instantiate_resources hash, holder
+        hash[collection_name(:xml)].collect {|res| instantiate_resource(res, holder)}
+      end
+      
+      def create *args
+        returning(self.new(*args)) { |res| res.save }
+      end
+      
+      def find(*args)
+        holder = args.pop
+        scope = args.shift
+        options = args.shift || {}
+        
+        case scope
+        when :all then find_every(options, holder)
+        when :mine then find_mine(options, holder)
+        when :first then find_every(options, holder).first
+        else find_single(scope, options, holder)
+        end
+      end
+      
+      def find_every(options, holder)
+        instantiate_resources(Hash.from_xml(holder.get("/#{collection_name}?" + options.to_query)), holder)
+      end
+      
+      def find_mine(options, holder)
+        instantiate_resources(Hash.from_xml(holder.get("/#{collection_name}/mine?" + options.to_query)), holder)
+      end    
+      
+      def find_single(scope, options, holder)
+        instantiate_resource(Hash.from_xml(holder.get("/#{collection_name}/#{scope}?" + options.to_query))[singular_name(:xml)], holder)
+      end
+    end # end of class methods of Resource
+    
+    def initialize(*args)
+      @holder = args.pop
+      @hash = args.shift
+    end
+    
+    def update(attributes)
+      @hash.update(attributes)
+      save
+    end
+    
+    def id
+      @hash["identifier"]
+    end
+    
+    def new?
+      @hash["identifier"].blank?
+    end
+    
+    def parameters
+      returning({}) do |params|
+        self.class.save_params.each do |key|
+          params["#{self.class.singular_name}[#{key}]"] = @hash[key].to_s unless @hash[key].blank?
+        end
+      end
+    end
+    
+    def save
+      if new?
+        xml = @holder.post("/#{self.class.collection_name}/#{id}", parameters)
+      else
+        xml = @holder.put("/#{self.class.collection_name}/#{id}", parameters)
+      end
+      
+      @hash = Hash.from_xml(xml)[self.class.singular_name(:xml)]
+      self
+    end
+    
+    def destroy
+      xml = @holder.delete("/#{self.class.collection_name}/#{id}")
+      @hash = Hash.from_xml(xml)
+    end
+    
+    def method_missing(method, *args)
+      str = method.to_s
+      (str[-1] == ?=)? @hash[str[0..-2]] = args[0] : @hash[str]
+    end          
+  end
+end

data/lib/storyq_client/token.rb

@@ -0,0 +1,60 @@
+module Storyq
+  module Token
+    def access_token
+      @access_token ||= create_access_token
+    end
+    
+    def access_token=(token)
+      @access_toke = token
+    end
+    
+    def config=(config)
+      @config = config
+    end
+      
+    def create_access_token
+      if access_key and access_secret
+        OAuth::AccessToken.new consumer, access_key, access_secret
+      else
+        authorize
+      end
+    end
+      
+    def access
+      {"key" => access_key, "secret" => access_secret}
+    end
+    
+    def access=(access)
+      @config[:access_key] = access["key"]
+      @config[:access_secret] = access["secret"]
+    end
+    
+    def access_key
+       @config[:access_key]
+    end
+    
+    def access_secret
+      @config[:access_secret]
+    end
+    
+    def consumer
+      @consumer ||= OAuth::Consumer.new(
+        @config[:consumer_token], @config[:consumer_secret], 
+        :site=>@config[:site])      
+    end
+      
+    def authenticate 
+      req_token = consumer.get_request_token
+      puts "Authorize yourself using the following URL and press any key"
+      puts req_token.authorize_url
+      gets
+      acc_token = req_token.get_access_token
+      @config[:access_key] = acc_token.token
+      @config[:access_secret] = acc_token.secret      
+      acc_token
+    rescue Exception => e
+      puts e
+      return nil
+    end    
+  end
+end

data/lib/storyq_client/upload.rb

@@ -0,0 +1,46 @@
+require "tempfile"
+require "fileutils"
+
+module Storyq
+  module Upload
+    def boundary
+      @boundary ||= "----------STORYQ#{rand(1000000000000)}"
+    end
+        
+    def multipart_body(params, boundary)
+      params.map do |key, value|
+        if value.respond_to?(:original_filename)
+          File.open(value.path) do |f|
+            f.binmode
+            <<-EOF
+--#{boundary}\r
+Content-Disposition: form-data; name="#{key}"; filename="#{CGI.escape(value.original_filename)}"\r
+Content-Type: #{value.content_type}\r
+\r
+#{f.read}\r
+            EOF
+          end
+        else
+          <<-EOF
+--#{boundary}\r
+Content-Disposition: form-data; name="#{key}"\r
+\r
+#{value}\r
+          EOF
+        end
+      end.join("")+"--#{boundary}--\r"
+    end
+
+    def uploaded_file(path, content_type="application/octet-stream", filename=nil)
+      filename ||= File.basename(path)
+      t = Tempfile.new(filename)
+      FileUtils.copy_file(path, t.path)
+      (class << t; self; end;).class_eval do
+        alias local_path path
+        define_method(:original_filename) { filename }
+        define_method(:content_type) { content_type }
+      end
+      return t
+    end
+  end
+end

data/lib/storyq_client.rb

@@ -0,0 +1,16 @@
+%w(rubygems oauth oauth/consumer activesupport yaml).each {|l| require l}
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "storyq_client/base"
+
+module OAuth::RequestProxy::Net
+  module HTTP
+    class HTTPRequest < OAuth::RequestProxy::Base
+      def post_params
+        request.body if request.content_type == "application/x-www-form-urlencoded"
+      end
+    end
+  end
+end

data/test/base_spec.rb

@@ -0,0 +1,7 @@
+require 'storyq/base'
+
+describe StoryQ::Base, "" do
+  before(:each) do
+  end
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: aproxacs-storyq_client
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- aproxacs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+description: StoryQ client Library. This library makes it easy to use storyq's Open API.  You can easily upload documents and photos to the storyq and convert them to the flash slide with this library.  This follows the restful style but not use active_resource.
+email: aproxacs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- lib/storyq_client.rb
+- lib/storyq_client/base.rb
+- lib/storyq_client/box.rb
+- lib/storyq_client/photo.rb
+- lib/storyq_client/resource.rb
+- lib/storyq_client/token.rb
+- lib/storyq_client/upload.rb
+has_rdoc: true
+homepage: http://www.aproxacs.com/166
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: StoryQ client
+test_files: 
+- test/base_spec.rb