springnote_resources 0.2.1 → 0.4

data/History.txt

@@ -1,3 +1,16 @@
+== 0.4
+* ActiveResourceExtension added.
+* query pages with multiple identifiers.
+* CommonParameters added. Now you can configure domain.
+  with CommonParametersExtension.
+* Attachment has source method.
+
+== 0.3 / 2007-12-10
+* Page get search, with_tags methods.
+* protocol can be changed.
+* Attachment resource added
+* PageImport added
+
 == 0.2.1 / 2007-8-6
 * tiny naming fix for rubygems
 

data/Manifest.txt

@@ -1,13 +1,19 @@
 History.txt
 Manifest.txt
 README.txt
+README.korean.txt
 Rakefile
 Todo.txt
+init.rb
 lib/springnote_resources.rb
+lib/springnote/attachment.rb
 lib/springnote/base.rb
 lib/springnote/configuration.rb
 lib/springnote/lock.rb
 lib/springnote/page.rb
+lib/springnote/page_import.rb
 lib/springnote/revision.rb
+lib/exts/active_resource_extension.rb
+lib/exts/common_parameters.rb
 spec/base_spec.rb
-spec/configuration_spec.rb
+spec/configuration_spec.rb

data/README.korean.txt

@@ -0,0 +1,75 @@
+= Springnote Resources
+
+* 홈페이지: http://myruby.net/pages/391111
+* 제작자: deepblue (http://myruby.net), Changshin Lee (http://www.iasandcb.pe.kr)
+
+== 설명:
+
+스프링노트는 REST API를 제공하며, 레일스 프로젝트의 일부인 REST 클라이언트 '액티브리소스(ActiveResource)'를 통해 
+매우 쉽게 접근할 수 있다. 이를 활용하면, 자신의 데이터베이스에서 ORM인 액티브레코드를 이용해 데이터를 읽고 쓰는 것처럼, 액티브리소스를 
+이용해 스프링노트에 있는 데이터를 쉽게 다룰 수 있다.
+
+== 요구사항:
+
+* activesupport
+* activeresource
+
+== 설치:
+
+* sudo gem install springnote_resources
+
+== 개발자키와 사용자키 발급 및 설정:
+
+1. 스프링노트 매시업을 작성하기 위해서는 먼저 개발자키가 필요하다. 이 키는 오픈마루 API 센터에서 발급받을 수 있다. 
+자세한 내용은 http://dev.springnote.com/pages/372760 에서 얻을 수 있다.
+
+2. 그리고 해당 개발자키에 대한 스프링노트 사용자키를 발급받아야 한다. 이 키 또한 API 센터에서 얻을 수 있다.
+자세한 내용은 http://dev.springnote.com/pages/372761에서 얻을 수 있다.
+
+3. 이렇게 받은 키를 스프링노트 리소스에서 사용하려면 아래처럼 설정한다.
+
+Springnote::Base.configuration.set :app_key => '__개발자키__',
+  :user_openid => 'http://user-open-id-url/',
+  :user_key => '__사용자키__'
+
+== 사용법:
+
+# 페이지 불러오기
+page = Springnote::Page.find(144)
+puts page.source
+
+# 페이지 수정하기
+page = Springnote::Page.find(144)
+page.source = '<p>New Contents</p>'
+page.save
+
+# 페이지 만들기
+page = Springnote::Page.create :title => 'NewName', :source => 'NewContents'
+
+# 페이지 지우기
+Springnote::Page.find(144).destroy
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Bryan Kang and Changshin Lee
+
+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/README.txt

@@ -1,7 +1,7 @@
 = Springnote Resources
 
-* Homepage: http://deepblue.springnote.com/pages/391111
-* Author: Bryan Kang (http://myruby.net)
+* Homepage: http://myruby.net/pages/391111
+* Author: Bryan Kang (http://myruby.net), Changshin Lee (http://www.iasandcb.pe.kr)
 
 == DESCRIPTIONS:
 
@@ -16,11 +16,44 @@ ActiveResource wrapper library for Springnote.com's REST API
 
 * sudo gem install springnote_resources
 
+== How to get keys
+
+1. You need to register your application on Openmaru API Center and 
+get the application key. Read http://dev.springnote.com/pages/438963 
+for more details.
+
+2. Now you need to get the user key for the application you registered.
+Read http://dev.springnote.com/pages/438944 for more details.
+
+3. You have user OpenID, user key, and application key. Configure SpringnoteResources 
+with the information like following code:
+
+Springnote::Base.configuration.set :app_key => '__ApplicationKey_Here__',
+  :user_openid => 'http://user-open-id-url/',
+  :user_key => '__UserKey_Here__'
+
+== USAGE:
+
+# Load a page
+page = Springnote::Page.find(144)
+puts page.source
+
+# Update the page
+page = Springnote::Page.find(144)
+page.source = '<p>New Contents</p>'
+page.save
+
+# Create a new page
+page = Springnote::Page.create :title => 'NewName', :source => 'NewContents'
+
+# Destroy the page
+Springnote::Page.find(144).destroy
+
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2007 Bryan Kang
+Copyright (c) 2007 Bryan Kang and Changshin Lee
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/init.rb

@@ -0,0 +1 @@
+require 'springnote_resources'

data/lib/exts/active_resource_extension.rb

@@ -0,0 +1,25 @@
+module ActiveResourceExtension
+  def find(*args)
+    if multiple_query?(args)
+      return super(:all, :params => { :identifiers => args.join(','), :detail => true })
+    end
+
+    scope   = args.slice!(0)
+    options = convert_options(args.slice!(0) || {})
+    super(scope, options)
+              
+  # empty elements result causes error in typecast_xml_value because of xmlns of springnote
+  rescue RuntimeError
+    []
+  end
+  
+protected
+  def multiple_query?(args)
+    args.size > 1 && args[0].respond_to?(:to_int) && args[1].respond_to?(:to_int)
+  end
+  
+  def convert_options(args)
+    return args if args.empty? || args.include?(:from) || args.include?(:params)
+    {:params => args}
+  end
+end

data/lib/exts/common_parameters.rb

@@ -0,0 +1,21 @@
+module CommonParameters
+  def self.included(mod)
+    mod.alias_method_chain :request, :commons
+    mod.send :cattr_accessor, :common_params
+    mod.common_params = {}
+  end
+    
+  def request_with_commons(method, path, *arguments)
+    unless common_params.empty?
+      path += path.include?('?') ? '&' : '?'
+      path += common_params.to_query
+    end
+    request_without_commons(method, path, *arguments)
+  end
+  
+  def common_params
+    self.class.common_params
+  end  
+end
+
+ActiveResource::Connection.send :include, CommonParameters

data/lib/springnote/attachment.rb

@@ -0,0 +1,13 @@
+module Springnote
+  class Attachment < Base
+    set_prefix      '/pages/:relation_is_part_of/'
+    
+    def source
+      http = Net::HTTP.new(Springnote::Configuration::SERVER_URL, 80)
+      req = Net::HTTP::Get.new(element_path[0..-5])
+      req.basic_auth(Springnote::Base.site.user, Springnote::Base.site.password)
+      response = http.request(req)
+      response.body
+    end
+  end
+end # module Springnote

data/lib/springnote/base.rb

@@ -1,7 +1,9 @@
 module Springnote
-  VERSION = "0.2.1"
+  VERSION = "0.4"
   
   class Base < ActiveResource::Base
+    extend ActiveResourceExtension
+    
     set_primary_key 'identifier'
     
     def id

data/lib/springnote/configuration.rb

@@ -5,17 +5,20 @@ module Springnote
   
   class Configuration
     attr_writer :app_key, :user_key, :user_openid
+    attr_reader :domain
+    
+    SERVER_PROTOCOL = 'https'
     SERVER_URL = "api.springnote.com"
 
     def site
-      "https://#{username}:#{password}@#{SERVER_URL}/"
+      "#{SERVER_PROTOCOL}://#{username}:#{password}@#{SERVER_URL}/"
     end
     
     def load(file)
       set YAML.load(File.read(file))
     end
         
-    def set(options)
+    def set(options = {})
       options.each{|k,v| self.send("#{k}=", v)}
       Springnote::Base.site = self.site
       self
@@ -32,5 +35,9 @@ module Springnote
     def app_key
       @app_key or raise MissingConfiguration
     end
+    
+    def domain=(name = nil)
+      ActiveResource::Connection.common_params[:_domain] = name
+    end
   end
 end # module Springnote

data/lib/springnote/lock.rb

@@ -1,5 +1,5 @@
 module Springnote
   class Lock < Base
-    set_prefix      '/pages/:page_id/'
+    set_prefix      '/pages/:relation_is_part_of/'
   end
-end
+end # module Springnote

data/lib/springnote/page.rb

@@ -1,7 +1,17 @@
-module Springnote
-  class Page < Base        
-    def lock
-      Lock.find(:page_id => self.id)
-    end    
+class Springnote::Page < Springnote::Base  
+  def self.with_tags(tags, params = {})
+    find(:all, :params => prarams.reverse_merge(:tags => tags))
+  end
+
+  def self.search(query, params = {})
+    find(:all, :params => params.reverse_merge(:q => query))
+  end
+  
+  def lock
+    @lock ||= Lock.find(:relation_is_part_of => self.id)
+  end
+
+  def attachments
+    @attachments ||= Attachment.find(:all, :params => {:relation_is_part_of => self.id})
   end
 end

data/lib/springnote/page_import.rb

@@ -0,0 +1,59 @@
+module Springnote::PageImport
+  BOUNDARY = 'AaB03x'
+  
+  module ClassMethod
+    def import_file(path)
+      new.import_file(path)
+    end  
+  end
+
+  def import_file(path)
+    body = File.open(path) do |f|
+      create_query_multipart_str({:Filedata => f}, BOUNDARY)
+    end  
+    headers = self.class.headers.merge 'Content-Transfer-Encoding' => 'binary',
+      'Content-Length' => body.length.to_s,
+      'Content-Type' => "multipart/form-data; boundary=#{BOUNDARY}"
+
+    returning connection.post(collection_path, body, headers) do |response|
+      self.id = id_from_response(response)
+      load_attributes_from_response(response)
+    end
+    self      
+  end
+  
+  def self.included(base)
+    base.extend(ClassMethod)
+  end
+  
+
+protected
+  # COPY from ruby/facets 1.8.54
+  def create_query_multipart_str(query, boundary)
+    query.collect { |attr, value|
+      value ||= ''
+      if value.is_a? File
+        params = {
+          'filename' => value.path,
+          # Creation time is not available from File::Stat
+          # 'creation-date' => value.ctime.rfc822,
+          'modification-date' => value.mtime.rfc822,
+          'read-date' => value.atime.rfc822,
+        }
+        param_str = params.to_a.collect { |k, v|
+          "#{k}=\"#{v}\""
+        }.join("; ")
+        "--#{boundary}\r\n" +
+          %{Content-Disposition: form-data; name="#{attr.to_s}"; #{param_str}\r\n} +
+          "Content-Transfer-Encoding: binary\r\n" + 
+          "Content-Type: application/octet-stream\r\n\r\n#{value.read}\r\n"
+      else
+        "--#{boundary}\r\n" +
+          %{Content-Disposition: form-data; name="#{attr.to_s}"\r\n} +
+          "\r\n#{value.to_s}\r\n"
+      end
+    }.join('') + "--#{boundary}--\r\n"
+  end  
+end
+
+Springnote::Page.send :include, Springnote::PageImport

data/lib/springnote/revision.rb

@@ -1,5 +1,5 @@
 module Springnote
   class Revision < Base
-    set_prefix      '/pages/:page_id/'
+    set_prefix      '/pages/:relation_is_part_of/'
   end
-end
+end # module Springnote

data/lib/springnote_resources.rb

@@ -7,12 +7,19 @@ unless defined?(ActiveResource)
     require 'active_resource'  
   rescue LoadError
     require 'rubygems'
-    gem 'activeresource'
+    require 'activeresource'
   end
 end
 
+# extend activeresource
+require 'exts/common_parameters'
+require 'exts/active_resource_extension'
+
+# Springnote's resources
 require 'springnote/configuration'
 require 'springnote/base'
 require 'springnote/page'
+require 'springnote/attachment'
 require 'springnote/lock'
 require 'springnote/revision'
+

metadata

@@ -1,70 +1,84 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: springnote_resources
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-08-06 00:00:00 +09:00
-summary: ActiveResource wrapper library for Springnote.com's REST API
-require_paths: 
-- lib
-email: byblue@gmail.com
-homepage: http://deepblue.springnote.com/pages/391111
-rubyforge_project: springnote
-description: "== DESCRIPTIONS:  ActiveResource wrapper library for Springnote.com's REST API  == REQUIREMENTS:  * activesupport * activeresource"
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: "0.4"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Bryan Kang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-17 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "== DESCRIPTIONS:  ActiveResource wrapper library for Springnote.com's REST API  == REQUIREMENTS:  * activesupport * activeresource"
+email: byblue@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- README.korean.txt
+- Todo.txt
 files: 
 - History.txt
 - Manifest.txt
 - README.txt
+- README.korean.txt
 - Rakefile
 - Todo.txt
+- init.rb
 - lib/springnote_resources.rb
+- lib/springnote/attachment.rb
 - lib/springnote/base.rb
 - lib/springnote/configuration.rb
 - lib/springnote/lock.rb
 - lib/springnote/page.rb
+- lib/springnote/page_import.rb
 - lib/springnote/revision.rb
+- lib/exts/active_resource_extension.rb
+- lib/exts/common_parameters.rb
 - spec/base_spec.rb
 - spec/configuration_spec.rb
-test_files: []
-
+has_rdoc: true
+homepage: http://myruby.net/pages/391111
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Todo.txt
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.2
-    version: 
+rubyforge_project: springnote
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ActiveResource wrapper library for Springnote.com's REST API
+test_files: []
+