jsonrpc 0.9.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.9.0
+
+Initial officially released version

data/LICENSE

@@ -0,0 +1,20 @@
+JsonRPC, Copyright (c) 2008 Dirkjan Bussink
+
+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

@@ -0,0 +1,5 @@
+Extremely simple Ruby JSON RPC Client
+
+This plugin lets you easily call methods over a JSON RPC interface. It
+currently implements the bare minimum, feel free to submit pull requests
+if you implement additional functionality.

data/Rakefile

@@ -0,0 +1,49 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'spec/rake/spectask'
+
+require File.join(File.dirname(__FILE__), 'lib/jsonrpc', 'version')
+
+PKG_DISPLAY_NAME   = 'JsonRPC'
+PKG_NAME           = PKG_DISPLAY_NAME.downcase
+PKG_VERSION        = JsonRPC::VERSION::STRING
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME       = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = PKG_NAME
+RUBY_FORGE_USER    = "dbussink"
+RUBY_FORGE_PATH    = "/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}"
+RUBY_FORGE_URL     = "http://#{RUBY_FORGE_PROJECT}.rubyforge.org/"
+
+PKG_SUMMARY        = "JSON RPC implementation"
+PKG_DESCRIPTION    = <<-TEXT
+Very simple JSON RPC client implementation
+TEXT
+
+PKG_FILES = FileList[
+    "lib/**/*", "spec/**/*", "vendor/**/*",
+    "tasks/**/*", "website/**/*",
+    "[A-Z]*", "Rakefile"
+].exclude(/database\.yml/).exclude(/[_\.]git$/)
+
+RCOV_ENABLED = (RUBY_PLATFORM != "java" && RUBY_VERSION =~ /^1\.8/)
+if RCOV_ENABLED
+  task :default => "spec:verify"
+else
+  task :default => "spec"
+end
+
+WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/jsonrpc.rb

@@ -0,0 +1,33 @@
+gem 'addressable', '~>2.0.0'
+gem 'json'
+
+require 'net/http'
+require 'addressable/uri'
+require 'json'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'jsonrpc', 'version'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'jsonrpc', 'exceptions'))
+
+module JsonRPC
+
+  class Client
+
+    def initialize(url)
+      @address    = Addressable::URI.parse(url)
+    end
+
+    def request(method, params)
+      result = {}
+      params ||= {}
+      Net::HTTP.start(@address.host, @address.port) do |connection|
+        result = JSON.parse(connection.post(@address.path, {:method => method.to_s, :params => params}.to_json).body)
+      end
+      if error = result["error"]
+        raise JsonRPCError, error["message"]
+      end
+      result
+    end
+
+  end
+
+end

data/lib/jsonrpc/exceptions.rb

@@ -0,0 +1,6 @@
+module JsonRPC
+
+  class JsonRPCError < StandardError
+  end
+
+end

data/lib/jsonrpc/version.rb

@@ -0,0 +1,11 @@
+if !defined?(JsonRPC::VERSION)
+  module JsonRPC
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 9
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/spec/jsonrpc_spec.rb

@@ -0,0 +1,94 @@
+require 'net/http'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'jsonrpc'))
+
+# Mock around Net::HTTP so we don't need a real connection.
+# We just verify whether the correct data is posted and return
+# know test data
+
+class Net::HTTP < Net::Protocol
+  def connect
+  end
+end
+
+class Net::HTTPResponse
+  def body=(content)
+    @body = content
+    @read = true
+  end
+end
+
+class Net::HTTP < Net::Protocol
+
+  def self.raw_response_data
+    @raw_response_data
+  end
+
+  def self.raw_response_data=(data)
+    @raw_response_data = data
+  end
+
+  def self.raw_post_body=(body)
+    @raw_post_body = body
+  end
+
+  def self.raw_post_body
+    @raw_post_body
+  end
+
+  def self.raw_post_path=(path)
+    @raw_post_path = path
+  end
+
+  def self.raw_post_path
+    @raw_post_path
+  end
+
+  def post(path, body, headers = [])
+    res = Net::HTTPSuccess.new('1.2', '200', 'OK')
+    self.class.raw_post_path = path
+    self.class.raw_post_body = body
+    res.body = self.class.raw_response_data
+    res
+  end
+end
+
+describe JsonRPC::Client do
+
+  before do
+    @jsonrpc = JsonRPC::Client.new("http://localhost:4444/api")
+  end
+
+  it { @jsonrpc.should respond_to(:request) }
+
+  describe 'when it is successful' do
+
+    before do
+      @jsonrpc = JsonRPC::Client.new("http://localhost:4444/api")
+      Net::HTTP.raw_response_data = '{"result":200,"message":"what a great success!"}'
+      @result = @jsonrpc.request("test_method", {:param1 => "value1", :param2 => "value2" })
+    end
+
+    it 'should receive the correct call at the http level' do
+      JSON.parse(Net::HTTP.raw_post_body).should == JSON.parse('{"params":{"param1":"value1","param2":"value2"},"method":"test_method"}')
+    end
+
+    it 'should correctly parse the response from the server' do
+      @result.should == {"result" => 200, "message" => "what a great success!"}
+    end
+    
+  end
+
+  describe 'when it is not successful' do
+
+    before do
+      @jsonrpc = JsonRPC::Client.new("http://localhost:4444/api")
+      Net::HTTP.raw_response_data = '{"result":null,"error":{"message":"something is wrong!"}}'
+    end
+
+    it 'should raise an exception when a call went wrong' do
+      lambda { @jsonrpc.request("test_method", {:param1 => "value1", :param2 => "value2" }) }.should raise_error(JsonRPC::JsonRPCError)
+    end
+
+  end
+
+end

data/tasks/clobber.rake

@@ -0,0 +1,2 @@
+desc "Remove all build products"
+task "clobber"

data/tasks/gem.rake

@@ -0,0 +1,68 @@
+require "rake/gempackagetask"
+
+namespace :gem do
+  GEM_SPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+
+    s.files = PKG_FILES.to_a
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = %w( README )
+    s.rdoc_options.concat ["--main",  "README"]
+
+    if !s.respond_to?(:add_development_dependency)
+      puts "Cannot build Gem with this version of RubyGems."
+      exit(1)
+    end
+
+    s.add_development_dependency("rake", ">= 0.7.3")
+    s.add_development_dependency("rspec", ">= 1.0.8")
+    s.add_development_dependency("launchy", ">= 0.3.2")
+
+    s.require_path = "lib"
+
+    s.author = "Bob Aman"
+    s.email = "bob@sporkmonger.com"
+    s.homepage = RUBY_FORGE_URL
+    s.rubyforge_project = RUBY_FORGE_PROJECT
+  end
+
+  Rake::GemPackageTask.new(GEM_SPEC) do |p|
+    p.gem_spec = GEM_SPEC
+    p.need_tar = true
+    p.need_zip = true
+  end
+
+  desc "Show information about the gem"
+  task :debug do
+    puts GEM_SPEC.to_ruby
+  end
+
+  desc "Install the gem"
+  task :install => ["clobber", "gem:package"] do
+    sh "#{SUDO} gem install --local pkg/#{GEM_SPEC.full_name}"
+  end
+
+  desc "Uninstall the gem"
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PKG_NAME)
+    if installed_list &&
+        (installed_list.collect { |s| s.version.to_s}.include?(PKG_VERSION))
+      sh(
+        "#{SUDO} gem uninstall --version '#{PKG_VERSION}' " +
+        "--ignore-dependencies --executables #{PKG_NAME}"
+      )
+    end
+  end
+
+  desc "Reinstall the gem"
+  task :reinstall => [:uninstall, :install]
+end
+
+desc "Alias to gem:package"
+task "gem" => "gem:package"
+
+task "clobber" => ["gem:clobber_package"]

data/tasks/git.rake

@@ -0,0 +1,40 @@
+namespace :git do
+  namespace :tag do
+    desc "List tags from the Git repository"
+    task :list do
+      tags = `git tag -l`
+      tags.gsub!("\r", "")
+      tags = tags.split("\n").sort {|a, b| b <=> a }
+      puts tags.join("\n")
+    end
+
+    desc "Create a new tag in the Git repository"
+    task :create do
+      changelog = File.open("CHANGELOG", "r") { |file| file.read }
+      puts "-" * 80
+      puts changelog
+      puts "-" * 80
+      puts
+
+      v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+      abort "Versions don't match #{v} vs #{PKG_VERSION}" if v != PKG_VERSION
+
+      tag = "#{PKG_NAME}-#{PKG_VERSION}"
+      msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
+
+      existing_tags = `git tag -l instrument-*`.split("\n")
+      if existing_tags.include?(tag)
+        warn("Tag already exists, deleting...")
+        unless system "git tag -d #{tag}"
+          abort "Tag deletion failed."
+        end
+      end
+      puts "Creating git tag '#{tag}'..."
+      unless system "git tag -a -m \"#{msg}\" #{tag}"
+        abort "Tag creation failed."
+      end
+    end
+  end
+end
+
+task "gem:release" => "git:tag:create"

data/tasks/metrics.rake

@@ -0,0 +1,22 @@
+namespace :metrics do
+  task :lines do
+    lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+    for file_name in FileList["lib/**/*.rb"]
+      f = File.open(file_name)
+      while line = f.gets
+        lines += 1
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        codelines += 1
+      end
+      puts "L: #{sprintf("%4d", lines)}, " +
+        "LOC #{sprintf("%4d", codelines)} | #{file_name}"
+      total_lines     += lines
+      total_codelines += codelines
+
+      lines, codelines = 0, 0
+    end
+
+    puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,29 @@
+require "rake/rdoctask"
+
+namespace :doc do
+  desc "Generate RDoc documentation"
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = "doc"
+    rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
+    rdoc.options << "--line-numbers" << "--inline-source" <<
+      "--accessor" << "cattr_accessor=object" << "--charset" << "utf-8"
+    rdoc.template = "#{ENV["template"]}.rb" if ENV["template"]
+    rdoc.rdoc_files.include("README", "CHANGELOG", "LICENSE")
+    rdoc.rdoc_files.include("lib/**/*.rb")
+  end
+
+  desc "Generate ri locally for testing"
+  task :ri do
+    sh "rdoc --ri -o ri ."
+  end
+
+  desc "Remove ri products"
+  task :clobber_ri do
+    rm_r "ri" rescue nil
+  end
+end
+
+desc "Alias to doc:rdoc"
+task "doc" => "doc:rdoc"
+
+task "clobber" => ["doc:clobber_rdoc", "doc:clobber_ri"]

data/tasks/rubyforge.rake

@@ -0,0 +1,89 @@
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => ["gem:package"] do |t|
+    require 'rubyforge'
+
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PKG_VERSION
+    pkg = "pkg/#{GEM_SPEC.full_name}"
+
+    rf = RubyForge.new
+    rf.configure
+    puts 'Logging in...'
+    rf.login
+
+    c = rf.userconfig
+    changelog = File.open("CHANGELOG") { |file| file.read }
+    c['release_changes'] = changelog
+    c['preformatted'] = true
+
+    files = ["#{pkg}.tgz", "#{pkg}.zip", "#{pkg}.gem"]
+
+    puts "Releasing #{PKG_NAME} v. #{PKG_VERSION}"
+    rf.add_release RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, *files
+  end
+end
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => ["doc:rdoc"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + "/api"
+    local_dir = "doc"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end
+
+namespace :spec do
+  desc "Publish specdoc to RubyForge"
+  task :release => ["spec:specdoc"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + "/specdoc"
+    local_dir = "specdoc"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+
+  namespace :rcov do
+    desc "Publish coverage report to RubyForge"
+    task :release => ["spec:rcov"] do
+      require "rake/contrib/sshpublisher"
+      require "yaml"
+
+      config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+      )
+      host = "#{config['username']}@rubyforge.org"
+      remote_dir = RUBY_FORGE_PATH + "/coverage"
+      local_dir = "coverage"
+      Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+    end
+  end
+end
+
+namespace :website do
+  desc "Publish website to RubyForge"
+  task :release => ["doc:release", "spec:release", "spec:rcov:release"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH
+    local_dir = "website"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,63 @@
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color', '--format', 'specdoc']
+    if RCOV_ENABLED
+      t.rcov = true
+    else
+      t.rcov = false
+    end
+    t.rcov_opts = [
+      '--exclude', 'spec',
+      '--exclude', '1\\.8\\/gems',
+      '--exclude', '1\\.9\\/gems',
+    ]
+  end
+
+  Spec::Rake::SpecTask.new(:normal) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color', '--format', 'specdoc']
+    t.rcov = false
+  end
+
+  if RCOV_ENABLED
+    RCov::VerifyTask.new(:verify) do |t|
+      t.threshold = 100.0
+      t.index_html = 'coverage/index.html'
+    end
+
+    task :verify => :rcov
+  end
+
+  desc "Generate HTML Specdocs for all specs"
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    specdoc_path = File.expand_path(
+      File.join(File.dirname(__FILE__), '../specdoc/'))
+    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
+
+    output_file = File.join(specdoc_path, 'index.html')
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["--format", "\"html:#{output_file}\"", "--diff"]
+    t.fail_on_error = false
+  end
+
+  namespace :rcov do
+    desc "Browse the code coverage report."
+    task :browse => "spec:rcov" do
+      require "launchy"
+      Launchy::Browser.run("coverage/index.html")
+    end
+  end
+end
+
+if RCOV_ENABLED
+  desc "Alias to spec:verify"
+  task "spec" => "spec:verify"
+else
+  desc "Alias to spec:normal"
+  task "spec" => "spec:normal"
+end
+
+task "clobber" => ["spec:clobber_rcov"]

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: jsonrpc
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Bob Aman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+description: |
+  Very simple JSON RPC client implementation
+
+email: bob@sporkmonger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/jsonrpc/exceptions.rb
+- lib/jsonrpc/version.rb
+- lib/jsonrpc.rb
+- spec/jsonrpc_spec.rb
+- tasks/clobber.rake
+- tasks/gem.rake
+- tasks/git.rake
+- tasks/metrics.rake
+- tasks/rdoc.rake
+- tasks/rubyforge.rake
+- tasks/spec.rake
+- CHANGELOG
+- LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://jsonrpc.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: jsonrpc
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: JSON RPC implementation
+test_files: []
+