json-rpc-objects 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+   gem "multitype-introspection", ">= 0.1.0"
+   gem "hash-utils", ">= 0.3.0"
+   gem "types", ">= 0.1.0"
+   gem "version", ">= 0.9.2"
+   gem "addressable", ">= 2.2.2"
+   gem "yajl-ruby", ">= 0.7.8"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    git (1.2.5)
+    hash-utils (0.3.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    multitype-introspection (0.1.0)
+    rake (0.8.7)
+    types (0.1.0)
+      multitype-introspection (>= 0.1.0)
+    version (0.9.2)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable (>= 2.2.2)
+  bundler (~> 1.0.0)
+  hash-utils (>= 0.3.0)
+  jeweler (~> 1.5.2)
+  multitype-introspection (>= 0.1.0)
+  types (>= 0.1.0)
+  version (>= 0.9.2)
+  yajl-ruby (>= 0.7.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák
+
+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.md

@@ -0,0 +1,118 @@
+JSON-RPC Objects
+================
+
+**JSON-RPC Objects** are implementation of by [JSON-RPC][1] defined 
+objects with respect to specifications compliance and API backward 
+compatibility. It implements all versions of the protocol and support 
+for ability to communicate by the same protocol version which the 
+other side uses by a transparent way.
+
+It means, it implements following JSON-RPC versions:
+
+* [1.0][2] (*original specification*)
+* [1.1 WD][3] (*working draft*)
+* [1.1 Alt][4] (*alternative proposal*)
+* [2.0][5] (*revised specification proposal*)
+
+### Protocol Versions Compatibility
+
+All protocols are implemented from points of view of features which must
+complain to. Some of these aren't encouraged, but it's on will of the 
+user. 2.0 and 1.1 Alt implements some minor additions compared to 
+specification such as object extensions as defined in 1.1 WD, but 
+mainly because of API compatibility and functionallity reasons.
+
+All classes inherit from previous version so API is homogenous. 
+Application which can deal with 1.0 can deal with 2.0 too without any 
+funcionallity or logic lost. 
+
+### Usage
+
+All object classes have three creating class methods:
+
+* `#create(<some arguments>, opts = { })` &ndash; which creates new 
+object according to arguments (required members) and options (optional 
+members),
+* `#parse(string)` &ndash; which parses the JSON string,
+* `#new(data)` &ndash; which creates new object from hash.
+
+All names of both class names and optional arguments are exactly the 
+same as defined in specification.
+
+It can be used by two ways. You know either concrete version of the 
+protocol which you want to use in your application (typically client) 
+or you process some incoming request which can use whatever of 
+the versions (typically server).
+
+Concrete version use example (creates call to `subtract` method with 
+ID "a2b3"):
+
+    require "json-rpc-objects/v10/request"
+    require "json-rpc-objects/v11/alt/request"
+    require "json-rpc-objects/v20/request"
+    
+    JsonRpcObjects::V10::Request::create(:subtract, ["1", "2"], :id => "a2b3")
+    JsonRpcObjects::V11::Alt::Request::create(:subtract, ["1", "2"], :id => "a2b3")
+    JsonRpcObjects::V20::Request::create(:subtract, ["1", "2"], :id => "a2b3")
+    
+Or incoming data processing request:
+
+    require "json-rpc-objects/request"
+    JsonRpcObjects::Request::parse(string)
+    
+…which will simply return request object of appropriate class according 
+to its version. Be warn, to distinguish between 1.1 Alt and 1.1 WD is
+impossible in most of cases. It isn't problem for simple use, but it 
+can be problem in some special cases. Default is WD, but Alt can be set
+as default if it's required.
+
+### Transparent Processing
+
+In some cases, for example in case implementing of JSON-RPC server, you 
+need make response to request by the same protocol version. It can be 
+achieved by simple way:
+
+    require "json-rpc-objects/request"
+    
+    request = JsonRpcObjects::Request::parse(string)
+    ... <data processing>
+    response = request.class::version.response::create(<some args>)
+    
+This code analyzes protocol version of the request and creates response
+of the same protocol version. It utilizes call handler, so you can call
+for example `request.class::version.service_procedure_description::create(<arguments>)`
+for obtaining 1.1 service procedure description object. But be warn 
+again, neither 1.0 nor 2.0 implements these objects, so it can simply 
+cause `LoadError` in that case therefore it really isn't recommended.
+
+Be limited by `Error`, `Request` and `Response` classes here or check
+the protocol version using `#VERSION` class constant. Also note, 
+`Request` and `Response` are fake classes for 1.1, and `Error` for 1.0, 
+so correspondent 2.0 classes aren't ancestors of these, but of 
+`ProcedureCall` and `ProcedureReturn`. This may be subject of change in 
+future releases.
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][6] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright &copy; 2011 [Martin Kozák][7]. See `LICENSE.txt` for
+further details.
+
+[1]: http://en.wikipedia.org/wiki/JSON-RPC
+[2]: http://json-rpc.org/wiki/specification
+[3]: http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+[4]: http://groups.google.com/group/json-rpc/web/json-rpc-1-1-alt
+[5]: http://groups.google.com/group/json-rpc/web/json-rpc-2-0
+[6]: http://github.com/martinkozak/json-rpc-objects/issues
+[7]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "json-rpc-objects"
+  gem.homepage = "http://github.com/martinkozak/json-rpc-objects"
+  gem.license = "MIT"
+  gem.summary = 'Implementation of JSON-RPC objects with respect to specifications compliance and API backward compatibility. Implements all versions of the protocol and support for ability to communicate by the same protocol version which other side uses by a transparent way.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "types #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/json-rpc-objects.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{json-rpc-objects}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-01-13}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "json-rpc-objects.gemspec",
+    "lib/json-rpc-objects/error.rb",
+    "lib/json-rpc-objects/generic.rb",
+    "lib/json-rpc-objects/request.rb",
+    "lib/json-rpc-objects/response.rb",
+    "lib/json-rpc-objects/v10/error.rb",
+    "lib/json-rpc-objects/v10/fakes/error.rb",
+    "lib/json-rpc-objects/v10/request.rb",
+    "lib/json-rpc-objects/v10/response.rb",
+    "lib/json-rpc-objects/v10/tests/test.rb",
+    "lib/json-rpc-objects/v11/alt/error.rb",
+    "lib/json-rpc-objects/v11/alt/fakes/request.rb",
+    "lib/json-rpc-objects/v11/alt/fakes/response.rb",
+    "lib/json-rpc-objects/v11/alt/procedure-call.rb",
+    "lib/json-rpc-objects/v11/alt/procedure-parameter-description.rb",
+    "lib/json-rpc-objects/v11/alt/procedure-return.rb",
+    "lib/json-rpc-objects/v11/alt/request.rb",
+    "lib/json-rpc-objects/v11/alt/response.rb",
+    "lib/json-rpc-objects/v11/alt/service-description.rb",
+    "lib/json-rpc-objects/v11/alt/service-procedure-description.rb",
+    "lib/json-rpc-objects/v11/alt/tests/test.rb",
+    "lib/json-rpc-objects/v11/generic-types.rb",
+    "lib/json-rpc-objects/v11/wd/error.rb",
+    "lib/json-rpc-objects/v11/wd/extensions.rb",
+    "lib/json-rpc-objects/v11/wd/fakes/request.rb",
+    "lib/json-rpc-objects/v11/wd/fakes/response.rb",
+    "lib/json-rpc-objects/v11/wd/procedure-call.rb",
+    "lib/json-rpc-objects/v11/wd/procedure-parameter-description.rb",
+    "lib/json-rpc-objects/v11/wd/procedure-return.rb",
+    "lib/json-rpc-objects/v11/wd/request.rb",
+    "lib/json-rpc-objects/v11/wd/response.rb",
+    "lib/json-rpc-objects/v11/wd/service-description.rb",
+    "lib/json-rpc-objects/v11/wd/service-procedure-description.rb",
+    "lib/json-rpc-objects/v11/wd/tests/test.rb",
+    "lib/json-rpc-objects/v20/error.rb",
+    "lib/json-rpc-objects/v20/request.rb",
+    "lib/json-rpc-objects/v20/response.rb",
+    "lib/json-rpc-objects/v20/tests/test.rb",
+    "lib/json-rpc-objects/version.rb"
+  ]
+  s.homepage = %q{http://github.com/martinkozak/json-rpc-objects}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Implementation of JSON-RPC objects with respect to specifications compliance and API backward compatibility. Implements all versions of the protocol and support for ability to communicate by the same protocol version which other side uses by a transparent way.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multitype-introspection>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<hash-utils>, [">= 0.3.0"])
+      s.add_runtime_dependency(%q<types>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<version>, [">= 0.9.2"])
+      s.add_runtime_dependency(%q<addressable>, [">= 2.2.2"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0.7.8"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<multitype-introspection>, [">= 0.1.0"])
+      s.add_dependency(%q<hash-utils>, [">= 0.3.0"])
+      s.add_dependency(%q<types>, [">= 0.1.0"])
+      s.add_dependency(%q<version>, [">= 0.9.2"])
+      s.add_dependency(%q<addressable>, [">= 2.2.2"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0.7.8"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<multitype-introspection>, [">= 0.1.0"])
+    s.add_dependency(%q<hash-utils>, [">= 0.3.0"])
+    s.add_dependency(%q<types>, [">= 0.1.0"])
+    s.add_dependency(%q<version>, [">= 0.9.2"])
+    s.add_dependency(%q<addressable>, [">= 2.2.2"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0.7.8"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/json-rpc-objects/error.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require "json-rpc-objects/v20/response"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Error module for universal API.
+    #
+    
+    module Error
+            
+        ##
+        # Returns request of the latest standard.
+        # 
+        # @param [Array] args for target constructor
+        # @return [JsonRpcObjects::V11::Alt::Error]  error object
+        #
+        
+        def self.create(*args)
+            JsonRpcObjects::V11::Alt::Error::create(*args)
+        end
+                
+    end
+    
+end

data/lib/json-rpc-objects/generic.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+require "hash-utils"
+require "yajl/json_gem"
+require "json-rpc-objects/version"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module for generic object methods.
+    #
+    
+    module Generic
+    
+        ##
+        # Generic JSON-RPC Object.
+        # @abstract
+        #
+        
+        class Object
+        
+            ##
+            # Creates new one.
+            #
+            # @param [Array] args some arguments
+            # @return [JsonRpc::Generic::Object] new object
+            #
+            
+            def self.create(*args)
+                __abstract
+            end
+        
+            ##
+            # Returns the version object.
+            # @return [JsonRpcObjects::Version]  appropriate version object
+            #
+            
+            def self.version
+                JsonRpcObjects::Version::get(self::VERSION)
+            end
+          
+            ##
+            # Parses JSON-RPC string.
+            #
+            # @param [String] string with the JSON data
+            # @return [Generic::Object] of the given class
+            #
+            
+            def self.parse(string)
+                self::new(JSON.load(string)) 
+            end
+                        
+            ##
+            # Converts back to JSON.
+            # @return [String]
+            #
+            
+            def to_json
+                self.output.to_json
+            end
+                     
+            ##
+            # Constructor.
+            # @param [Hash] data for initializing the object
+            #
+            
+            def initialize(data)
+                self.data = data
+                self.check!
+            end
+
+            ##
+            # Checks correctness of the request data.
+            #
+            
+            def check!
+            end
+                        
+            ##
+            # Renders data to output form.
+            #
+            # @return [Object] with data of object
+            # @abstract
+            #
+
+            def output
+                __abstract
+            end
+            
+            
+            protected
+            
+            ##
+            # Assigns request data.
+            #
+
+            def data=(value, mode = nil)
+                __abstract
+            end
+            
+            ##
+            # Converts data keys from strings to symbols if necessary.
+            #
+            
+            def __convert_data(data, mode = nil)
+                if mode != :converted
+                    data.keys_to_sym
+                else
+                    data
+                end
+            end
+            
+            ##
+            # Converts request data to standard (defined) format.
+            #
+            
+            def normalize!
+            end
+
+            
+            private
+            
+            ##
+            # Raises method is abstract exception.
+            #
+            
+            def __abstract
+                self.class::__abstract
+            end
+            
+            ##
+            # Raises method is abstract exception.
+            #
+            
+            def self.__abstract
+                raise Exception::new("Method is abstract.")
+            end
+
+        end
+    end
+end