ripcord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da9d67bc7e6adaaf8718d86b62757b4605a24595
+  data.tar.gz: e21fa5867054573200bb32b372d4998e3d4d0020
+SHA512:
+  metadata.gz: 40cee178d2a9e784f9e95c37059e19153224d2bf6a4ae499e18d488321b3ed6ed39143217c59dd4e5a80187ebd1bd5899a7bca0ba5b1f89ff542e319c00beba5
+  data.tar.gz: 9220717aff0e7b43f7a637ec657268929ceab2f43b3c43f9cf7f60af9fb108f7c6dd83bdd94a8b1be04d626d0c9b15c542bf579ce6d45ba494c63cb0ea7b4743

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ripcord.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: "bundle exec rspec" do
+   watch('spec/spec_helper.rb')                                               { "spec" }
+   watch(%r{^spec/.+_spec\.rb})
+
+   watch(%r{^lib/(.+)\.rb})                                                   { |m| "spec/#{m[1]}_spec.rb" }
+ end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Klaus Zanders
+
+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,65 @@
+# RiPCord [![Build Status](https://travis-ci.org/klaustopher/ripcord.svg?branch=master)](https://travis-ci.org/klaustopher/ripcord)
+
+This is a [JSON-RPC 2.0](http://www.jsonrpc.org/specification) implementation. It is heavily based on [JSONRPC::Client](https://github.com/fxposter/jsonrpc-client) but has a lot of changes
+from the initial implementation that are sort of specific to our use case. But it might work for you as well.
+
+The name *R*i*PC*ord originates from me searching for a word that contained RPC :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ripcord'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+
+### Basic Usage
+```ruby
+client = Ripcord::Client.new('http://www.some-server.com/rpc-endpoint')
+
+client.call('add', [1,2])
+```
+
+### ... with Authentication
+
+```ruby
+# HTTP Basic Auth (https://tools.ietf.org/html/rfc2617)
+client.authentication = Ripcord::Authentication::HTTPBasicAuth.new('user', 'password')
+```
+
+```ruby
+# HTTP Token Auth (https://tools.ietf.org/html/draft-hammer-http-token-auth-01)
+client.authentication = Ripcord::Authentication::HTTPBasicAuth.new('some-token')
+```
+
+```ruby
+# Inline Token
+# This adds a token item to the root of the JSON request.
+client.authentication = Ripcord::Authentication::InlineToken.new('some-token')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klaustopher/ripcord.
+
+## Special thanks
+
+- [Pavel Forkert](https://github.com/fxposter/) for the initial implementation of `JSONRPC::Client`
+- [Clark Germany](https://www.clark.de) for paying me to work on this ;)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ripcord"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ripcord.rb

@@ -0,0 +1,6 @@
+require 'ripcord/version'
+require 'ripcord/client'
+
+module Ripcord
+  JSON_RPC_VERSION = '2.0'.freeze
+end

data/lib/ripcord/authentication.rb

@@ -0,0 +1,7 @@
+module Ripcord
+  module Authentication
+    require 'ripcord/authentication/http_basic_auth'
+    require 'ripcord/authentication/http_token_auth'
+    require 'ripcord/authentication/inline_token'
+  end
+end

data/lib/ripcord/authentication/http_basic_auth.rb

@@ -0,0 +1,11 @@
+module Ripcord::Authentication
+  class HTTPBasicAuth
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+
+    def apply_to(request, payload_hash)
+      request.basic_auth(@username, @password)
+    end
+  end
+end

data/lib/ripcord/authentication/http_token_auth.rb

@@ -0,0 +1,11 @@
+module Ripcord::Authentication
+  class HTTPTokenAuth
+    def initialize(token)
+      @token = token
+    end
+
+    def apply_to(request, payload_hash)
+      request.add_field 'Authorization', "Token token=#{@token}"
+    end
+  end
+end

data/lib/ripcord/authentication/inline_token.rb

@@ -0,0 +1,11 @@
+module Ripcord::Authentication
+  class InlineToken
+    def initialize(token)
+      @token = token
+    end
+
+    def apply_to(request, payload_hash)
+      payload_hash[:token] = @token
+    end
+  end
+end

data/lib/ripcord/base_client.rb

@@ -0,0 +1,36 @@
+require 'securerandom'
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Ripcord
+  class BaseClient
+    def generate_request_id
+      SecureRandom.hex(16)
+    end
+
+    attr_accessor :authentication
+
+    def initialize(endpoint_url)
+      @endpoint_url = URI.parse(endpoint_url)
+      @http_client = Net::HTTP.new(@endpoint_url.host, @endpoint_url.port)
+    end
+
+    protected
+    def execute_request(json_rpc_request)
+      request = Net::HTTP::Post.new(@endpoint_url.request_uri)
+      request.content_type = 'application/json'
+
+      payload_hash = json_rpc_request.to_payload
+
+      if authentication
+        authentication.apply_to(request, payload_hash)
+      end
+
+      request.body = JSON.generate(payload_hash)
+
+      @http_client.request(request)
+    end
+
+  end
+end

data/lib/ripcord/client.rb

@@ -0,0 +1,92 @@
+require 'ripcord/authentication'
+require 'ripcord/json_rpc'
+
+require 'securerandom'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'logger'
+
+module Ripcord
+  class Client
+    attr_accessor :authentication
+    attr_reader :logger, :last_request, :last_response
+
+    def initialize(endpoint_url)
+      @endpoint_url = URI.parse(endpoint_url)
+
+      set_basic_auth_from_url if @endpoint_url.user && @endpoint_url.password
+
+      @http_client = Net::HTTP.new(@endpoint_url.host, @endpoint_url.port)
+
+      if @endpoint_url.kind_of?(URI::HTTPS)
+        @http_client.use_ssl=true
+        #@http_client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    def call(method, params)
+      request = Ripcord::JsonRPC::Request.new(method, params, generate_request_id)
+      @last_request = request
+      http_response = execute_request(request)
+
+      parse_response(http_response)
+    end
+
+    def logger=(logger)
+      @logger = logger
+      @http_client.set_debug_output(logger)
+    end
+
+    def inspect
+      "#<Ripcord::Client endpoint=#{@endpoint_url.to_s}>"
+    end
+
+    private
+    def execute_request(json_rpc_request)
+      request = Net::HTTP::Post.new(@endpoint_url.request_uri)
+      request.content_type = 'application/json'
+
+      payload_hash = json_rpc_request.to_payload
+
+      if authentication
+        authentication.apply_to(request, payload_hash)
+      end
+
+      request.body = JSON.generate(payload_hash)
+
+      @http_client.request(request)
+    end
+
+    def parse_response(http_response)
+      # Check status code
+      status_code = http_response.code.to_i
+      if status_code < 200 || status_code > 299
+        raise Ripcord::Error::InvalidResponse.new(http_response.body)
+      end
+
+      # try to parse json
+      begin
+        json_data = JSON.parse(http_response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        raise Ripcord::Error::InvalidJSON.new(http_response.body)
+      end
+
+      if json_data.kind_of?(Hash) # Handle single response
+        Ripcord::JsonRPC::Response.from_data(json_data)
+      elsif json_data.kind_of?(Array) # Handle batch response
+        json_data.map do |request_json|
+          Ripcord::JsonRPC::Response.from_data(request_json)
+        end
+      end
+    end
+
+    def generate_request_id
+      SecureRandom.hex(16)
+    end
+
+    def set_basic_auth_from_url
+      self.authentication = Ripcord::Authentication::HTTPBasicAuth.new(@endpoint_url.user, @endpoint_url.password)
+    end
+  end
+end

data/lib/ripcord/error.rb

@@ -0,0 +1,18 @@
+module Ripcord
+  module Error
+    class InvalidResponse < StandardError
+      def initialize(response_body = nil)
+        message =  'Invalid or empty response from server.'
+        message += "\nResponse: #{response_body}" if response_body
+
+        super(message)
+      end
+    end
+
+    class InvalidJSON < StandardError
+      def initialize(response_body)
+        super("Couldn't parse JSON string received from server\nResponse: #{response_body}")
+      end
+    end
+  end
+end

data/lib/ripcord/json_rpc.rb

@@ -0,0 +1,8 @@
+module Ripcord
+  module JsonRPC
+    require 'ripcord/json_rpc/error'
+    require 'ripcord/json_rpc/request'
+    require 'ripcord/json_rpc/response'
+    require 'ripcord/json_rpc/notification'
+  end
+end

data/lib/ripcord/json_rpc/error.rb

@@ -0,0 +1,9 @@
+module Ripcord::JsonRPC
+  class Error
+    attr_reader :code, :message, :data
+
+    def initialize(code, message, data)
+      @code, @message, @data = code, message, data
+    end
+  end
+end

data/lib/ripcord/json_rpc/notification.rb

@@ -0,0 +1,10 @@
+require 'ripcord/json_rpc/request'
+
+module Ripcord::JsonRPC
+  class Notification < Request
+    def initialize(method, params)
+      @method, @params = method, params
+      @id = nil
+    end
+  end
+end

data/lib/ripcord/json_rpc/request.rb

@@ -0,0 +1,25 @@
+module Ripcord::JsonRPC
+  class Request
+    attr_accessor :method, :params
+    attr_reader :id
+
+    def initialize(method, params, id)
+      @method, @params, @id = method, params, id
+    end
+
+    def to_payload
+      {
+        jsonrpc: Ripcord::JSON_RPC_VERSION,
+        method: method,
+      }.tap do |payload_hash|
+        payload_hash[:params] = params if should_include_params?
+        payload_hash[:id] = id unless id.nil?
+      end
+    end
+
+    private
+    def should_include_params?
+      (params.kind_of?(Array) || params.kind_of?(Hash)) && !params.empty?
+    end
+  end
+end

data/lib/ripcord/json_rpc/response.rb

@@ -0,0 +1,45 @@
+require 'ripcord/error'
+require 'ripcord/json_rpc/error'
+
+module Ripcord::JsonRPC
+  class Response
+    attr_reader :result, :error, :id
+
+    def initialize(result, error, id)
+      @result, @id = result, id
+
+      @error = Ripcord::JsonRPC::Error.new(error[:code], error[:message], error[:data]) if error
+    end
+
+    def successful?
+      error.nil? && !result.nil?
+    end
+
+    class<<self
+      def from_data(json_data)
+        raise Ripcord::Error::InvalidResponse.new(json_data) unless valid_data?(json_data)
+
+        new(json_data[:result], json_data[:error], json_data[:id])
+      end
+
+      def valid_data?(json_data)
+        return false if !json_data.kind_of?(Hash)
+        return false if json_data[:jsonrpc] != Ripcord::JSON_RPC_VERSION
+        return false if !json_data.has_key?(:id)
+        return false if !(json_data.has_key?(:error) ^ json_data.has_key?(:result))
+
+        if json_data.has_key?(:error)
+          return false if !json_data[:error].kind_of?(Hash)
+          return false if !json_data[:error].has_key?(:code)
+          return false if !json_data[:error][:code].kind_of?(Fixnum)
+          return false if !json_data[:error].has_key?(:message)
+          return false if !json_data[:error][:message].kind_of?(String)
+        end
+
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/ripcord/version.rb

@@ -0,0 +1,3 @@
+module Ripcord
+  VERSION = "0.1.0"
+end

data/ripcord.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ripcord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ripcord"
+  spec.version       = Ripcord::VERSION
+  spec.authors       = ["Klaus Zanders", "Pavel Forkert"]
+  spec.email         = ["coding@kgz.me", "fxposter@gmail.com"]
+
+  spec.summary       = %q{This is a JSON-RPC 2.0 client implementation with some specific additions (custom auth schemes, etc)}
+  spec.description   = %q{JSON-RPC 2.0 client implementation}
+  spec.homepage      = "https://github.com/klaustopher/ripcord"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ripcord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klaus Zanders
+- Pavel Forkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSON-RPC 2.0 client implementation
+email:
+- coding@kgz.me
+- fxposter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ripcord.rb
+- lib/ripcord/authentication.rb
+- lib/ripcord/authentication/http_basic_auth.rb
+- lib/ripcord/authentication/http_token_auth.rb
+- lib/ripcord/authentication/inline_token.rb
+- lib/ripcord/base_client.rb
+- lib/ripcord/client.rb
+- lib/ripcord/error.rb
+- lib/ripcord/json_rpc.rb
+- lib/ripcord/json_rpc/error.rb
+- lib/ripcord/json_rpc/notification.rb
+- lib/ripcord/json_rpc/request.rb
+- lib/ripcord/json_rpc/response.rb
+- lib/ripcord/version.rb
+- ripcord.gemspec
+homepage: https://github.com/klaustopher/ripcord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This is a JSON-RPC 2.0 client implementation with some specific additions
+  (custom auth schemes, etc)
+test_files: []