chubas-pbruby 0.0.1

data/README.md

@@ -0,0 +1,9 @@
+# pbruby - The Peanut Buttered API
+
+This is Ruby Wrapper for [pbworks API][1]. Note that PBWorks API is not complete and has incomplete documentation.
+
+WIP
+
+
+  [1]: http://pbworks.com/api_v2/
+

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name          = "pbruby"
+    gem.summary       = "Ruby wrapper for PBWorks (formerly PBWiki) API"
+    gem.description   = "Peanut buttered Ruby! Access the PBWorks API (still in beta) from Ruby"
+    gem.email         = "ruben.medellin.c@gmail.com"
+    gem.homepage      = "http://github.com/chubas/pbruby"
+    gem.authors       = ["Rubén Medellín"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :default => :test
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  elsif File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "peeping #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 0

data/lib/pbruby/client.rb

@@ -0,0 +1,147 @@
+require 'rubygems'
+require 'mash'
+require 'httparty'
+
+module PBWiki
+  class Client
+
+    include HTTParty
+
+    attr_accessor :name
+    attr_accessor :read, :write, :admin
+
+    def initialize(name, keys = {})
+      @name = name
+      @read, @write, @admin = keys.values_at(:read, :write, :admin)
+    end
+
+    # Gets the method corresponding to the PBWorks v2 API, with the requested parameters.
+    def self.perform_api_request(verb, base_uri, format, secure, api_method, params = {})
+      response = send(verb,
+                        "/api_v2/",
+                        :base_uri   => base_uri,
+                        :query => {
+                          :op       => api_method,
+                          :_type    => 'jsontext'}.merge(params))
+      response = response.gsub(/^\/\*-secure-/, '').gsub(/\*\/$/, '').strip if secure
+      format == :json ? Mash.new(Crack::JSON.parse(response)) : response
+    rescue Crack::ParseError
+      raise "Malformed json response"
+    end
+
+    def request(verb, http_method, format, api_method, params, secure = true)
+      uri_prefix  = http_method == :https ? 'https' : 'http'
+      uri         = "#{uri_prefix}://#{@name}.pbworks.com/"
+
+      self.class.perform_api_request(verb, uri, format, secure, api_method, params)
+    end
+
+    class << self
+      alias old_method_missing method_missing
+      def method_missing(name, *args, &blk)
+        if name.to_s =~ /^pb_([a-z]+_)*(read|write|admin)$/
+
+          raise "A method name must be defined" unless args.size >= 1
+          raise "An API operation method name should be defined" unless args.size >= 2
+
+          s_method_name   = name.to_s.split('_')
+          def_parameters  = s_method_name[1...-1]    # Get the method words between
+          action_key      = s_method_name.last
+          method_name     = args.shift
+          api_method_name = args.shift
+          required_keys   = args
+
+          define_method(method_name) do |*api_method_params_optional_args|
+            api_method_params = api_method_params_optional_args[0] || {}
+            unless required_keys.all?{|key| api_method_params.keys.include?(key)}
+              raise "Error. Api method requires the following keys: #{args.inspect}"
+            end
+            verb        = def_parameters.include?('post')  ? :post  : :get
+            http_method = def_parameters.include?('https') ? :https : :http
+            format      = def_parameters.include?('plain') ? :plain : :json
+            secure      = def_parameters.include?('basic') ? false  : true
+            api_method_params.merge!("#{action_key}_key".to_sym => instance_variable_get("@#{action_key}"))
+            request(verb, http_method, format, api_method_name, api_method_params, secure)
+          end
+        else
+          old_method_missing(name, *args, &blk)
+        end
+      end
+    end
+
+    pb_read               :bundle,          'GetBundle'
+
+    pb_read               :changes,         'GetChanges'
+
+    pb_https_post_admin   :delete_file,     'DeleteFile',           :file            # **
+    pb_plain_admin        :file,            'GetFile',              :filename
+    pb_read               :file_revisions,  'GetFileRevisions'
+    pb_admin              :files,           'GetFiles'
+    pb_admin              :storage,         'GetStorageInfo'
+    pb_https_post_admin   :put_file,        'PutFile',              :data            # **
+    pb_https_post_admin   :rename_file,     'RenameFile',           :from, :to
+    pb_https_post_admin   :revert_file,     'RevertFile',           :file, :revision
+    
+    pb_https_post_admin   :create_folder,   'CreateFolder',         :folder
+    pb_https_post_admin   :delete_folder,   'DeleteFolder',         :folder
+    pb_read               :file_folder,     'GetFileFolder',        :file
+    pb_read               :folder_objects,  'GetFolderObjects',     :folder
+    pb_read               :page_folder,     'GetPageFolder',        :page
+    pb_admin              :folders,         'GetFolders'
+    pb_admin              :file_folders,    'GetFileFolders'
+    pb_https_post_admin   :rename_folder,   'RenameFolder',         :folder, :to      # **
+    pb_https_post_admin   :set_file_folder, 'SetFileFolder',        :file
+    pb_https_post_admin   :set_page_folder, 'SetPageFolder',        :page
+
+    pb_admin              :create_user,     'CreateUser',           :user, :password
+    pb_admin              :create_wiki,     'CreateWiki',           :tz, :wiki, :cat
+    pb_admin              :index,           'Index'
+    pb_admin              :multi,           'Multi',                :calls
+    pb_read               :render,          'RenderContent',        :text
+
+    pb_read               :templates,       'GetTemplates'
+    pb_read               :times,           'GetTimes'
+
+    pb_admin              :network_users,   'GetNewtorkUsers',      :anchor, :count, :filter, :offset, :sortby, :reverse, :verbose, :perm, :pending
+
+    pb_admin              :objects,         'GetObjects',           :folder
+    pb_admin              :ops,             'GetOps'
+    pb_admin              :help,            'Help',                 :help
+    pb_admin              :is_hiring,       'IsHiringEngineers'
+    pb_read               :pagebase,        'PageBase'
+    pb_admin              :ping,            'Ping'
+
+    pb_https_post_write   :append_page,     'AppendPage',           :page, :html
+    pb_https_post_write   :create_page,     'CreatePage',           :page
+    pb_write              :delete_autosave, 'DeleteAutosave',       :page
+    pb_https_post_admin   :delete_page,     'DeletePage',           :page
+    
+    pb_admin              :page,            'GetPage',              :page
+    pb_admin              :page_lock,       'GetPageLock',          :page
+    pb_admin              :page_security,   'GetPageSecurity',      :page
+    pb_read               :pages,           'GetPages'
+    pb_read               :search,          'Search',               :q
+
+    pb_admin              :folder_security, 'GetFolderSecurity',    :folder
+
+    pb_read               :page_tags,       'GetPageTags',          :page
+    pb_read               :tag_pages,       'GetTagPages',          :tag
+    pb_read               :tags,            'GetTags'
+
+    pb_read               :milestone,       'GetMilestone',         :milestone_id
+    pb_read               :milestones,      'GetMilestones'
+    pb_read               :task,            'GetTask',              :task_id
+    pb_read               :task_events,     'GetTaskEvents',        :task_id
+    pb_read               :tasks,           'GetTasks'
+
+    pb_read               :user,            'GetUserInfo'
+    pb_read               :user_pref,       'GetUserPref',          :key
+    pb_read               :user_prefs,      'GetUserPrefs',         :keys
+    pb_admin              :users,           'GetUsersInfos'
+
+    pb_admin              :upgrade_info,    'GetUpgradeInfo',       :wiki
+    pb_admin              :leave,           'LeaveWorkspace',       :wiki
+
+  end
+end
+

data/lib/pbruby/pb_methods.rb

@@ -0,0 +1 @@
+

data/pbruby.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pbruby}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rub\303\251n Medell\303\255n"]
+  s.date = %q{2009-08-26}
+  s.description = %q{Peanut buttered Ruby! Access the PBWorks API (still in beta) from Ruby}
+  s.email = %q{ruben.medellin.c@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "Rakefile",
+     "TODO",
+     "VERSION.yml",
+     "lib/pbruby.rb",
+     "lib/pbruby/client.rb",
+     "lib/pbruby/pb_methods.rb",
+     "pbruby.gemspec",
+     "setup.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/chubas/pbruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Ruby wrapper for PBWorks (formerly PBWiki) API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: chubas-pbruby
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Rub\xC3\xA9n Medell\xC3\xADn"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Peanut buttered Ruby! Access the PBWorks API (still in beta) from Ruby
+email: ruben.medellin.c@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- VERSION.yml
+- lib/pbruby.rb
+- lib/pbruby/client.rb
+- lib/pbruby/pb_methods.rb
+- pbruby.gemspec
+- setup.rb
+has_rdoc: true
+homepage: http://github.com/chubas/pbruby
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+summary: Ruby wrapper for PBWorks (formerly PBWiki) API
+test_files: []
+