springnote_client 0.0.2

data/History.txt

@@ -0,0 +1,7 @@
+= 0.0.2 2008-06-10
+* gem published
+
+== 0.0.1 2008-03-27
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+lib/springnote_client.rb
+lib/springnote_client/base.rb
+lib/springnote_client/version.rb

data/README.txt

@@ -0,0 +1,72 @@
+= springnote_client
+
+* Homepage: http://myruby.net/pages/1329390
+* Author: deepblue(http://myruby.net)
+
+== DESCRIPTION:
+
+Springnote Client Library without ActiveResource
+
+== FEATURES/PROBLEMS:
+
+* This is a technical preview version. APIs can be changed.
+
+== SYNOPSIS:
+
+# Instantiate a note
+note = Springnote('rubyseminar', 
+  :app_key => '__YOUR_APP_KEY__',
+  :user_openid => 'http://openid.myid.net/',
+  :user_key => '__YOUR_USER_KEY__')
+
+# Get a page
+page = note.pages.find(1325546)
+puts page.title
+
+# Update a page
+page.title += '_'
+page.source += '_'
+page.save
+
+# Create a page
+page = note.pages.build(:title => Time.now.to_s, :source => Time.now.to_s, :relation_is_part_of => 1329222)
+page.save
+
+# Get several pages
+pages = note.pages.find(1325546, 1325544)
+puts pages.map{|page| page.title}.join(',')
+ 
+
+== REQUIREMENTS:
+
+* rest_client
+* active_support
+
+== INSTALL:
+
+* sudo gem install springnote_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/springnote_client/base.rb

@@ -0,0 +1,110 @@
+module RestClient
+	class Resource
+		attr_accessor :url
+	end
+end
+
+
+module Springnote
+  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
+  
+  class Resource < RestClient::Resource
+    XML = 'application/xml'
+    attr_accessor :hash, :holder
+    
+    class << self
+      def build(hsh, holder)
+        new_resource(collection_url(holder), holder, hsh)
+      end      
+      
+      def new_resource(url, holder, hash = nil)
+        ret = new(url, holder.username, holder.password)
+        ret.holder = holder
+        
+        if block_given?
+          ret.hash = yield(ret)
+        elsif hash
+          ret.hash = hash
+        end
+
+        ret
+      end
+      
+      def element_url(holder, id, params = {})
+        holder.url("/#{collection_name}/#{id}", params)
+      end
+
+      def collection_url(holder, params = {})
+        holder.url("/#{collection_name}", params)
+      end      
+      
+      def find(*args)
+        holder = args.pop
+
+        args.length == 1 ? 
+          find_one(args[0], holder) : 
+          find_some(args, holder)
+      end
+      
+      def find_one(id, holder)
+        new_resource(element_url(holder, id), holder) do |ret| 
+          Hash.from_xml(ret.get(:accept => XML))[ret.singular_name]
+        end
+      end
+
+      def find_some(ids, holder)
+        ret = new_resource(collection_url(holder, :identifiers => ids.join(','), :detail => true), holder).get(:accept => 'application/xml')
+        Hash.from_xml(ret)[collection_name].map do |item|
+          new_resource(element_url(holder, item['identifier']), holder, item)
+        end
+      rescue RuntimeError
+        []  
+      end
+    end 
+    
+    def method_missing(method, *args)
+      str = method.to_s
+      str[-1] == ?= ?
+        @hash[str[0..-2]] = args[0] : 
+        @hash[str]
+    end
+    
+    def save
+      xml = @hash.to_xml(:root => singular_name)
+      
+      if @hash['identifier']
+        put xml, :content_type => XML
+      else
+        ret = post(xml, :content_type => XML)
+        @hash = Hash.from_xml(ret)[singular_name]
+        self.url = element_url
+      end
+      
+      self
+    end
+    
+    def element_url
+      self.class.element_url(holder, @hash['identifier'])
+    end
+    
+    def singular_name
+      self.class.singular_name
+    end
+    
+    def inspect
+      @hash.inspect
+    end
+    
+    def to_s
+      @hash.to_s
+    end
+  end
+end

data/lib/springnote_client/version.rb

@@ -0,0 +1,9 @@
+module SpringnoteClient #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/springnote_client.rb

@@ -0,0 +1,47 @@
+%w(rubygems rest_client cgi active_support).each{|lib| require lib}
+
+$:.unshift File.dirname(__FILE__)
+require 'springnote_client/base'
+
+def Springnote(*params)
+  Springnote::Note.new(*params)
+end
+
+module Springnote
+  class Note
+    attr_accessor :name, :config
+    
+    # config should have app_key, user_openid, user_key
+    def initialize(name, config)
+      @name, @config = name, config
+    end
+  
+    def pages
+      CallProxy.new(Page, self)
+    end
+        
+    def username
+      CGI.escape(@config[:user_openid] || 'anonymous')
+    end
+    
+    def password
+      @config[:user_key] ? "#{@config[:user_key]}.#{@config[:app_key]}" : @config[:app_key]
+    end
+    
+    def url(path = '/', params = {})
+      query = params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+      "http://api.springnote.com#{path}?domain=#{@name}&#{query}"
+    end
+  end
+  
+
+  class Page < Resource    
+    def self.singular_name
+      'page'
+    end
+    
+    def self.collection_name
+      'pages'
+    end    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/springnote_client'

data/test/test_springnote_client.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSpringnoteClient < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: springnote_client
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Bryan Kang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-11 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: Springnote Client
+email: 
+- byblue@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- lib/springnote_client.rb
+- lib/springnote_client/base.rb
+- lib/springnote_client/version.rb
+has_rdoc: true
+homepage: http://springnote.rubyforge.org
+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: springnote
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Springnote Client
+test_files: 
+- test/test_helper.rb
+- test/test_springnote_client.rb