mm_json_client 0.1.0

data/lib/mm_json_client/json_rpc_http/client.rb

@@ -0,0 +1,40 @@
+require 'json'
+require 'mm_json_client/http_client/client'
+require 'mm_json_client/json_rpc_http/response'
+
+module MmJsonClient
+  module JsonRpcHttp
+    # A helper client for doing JSON-RPC calls over http.
+    class Client
+      def initialize(base_url, options = {})
+        @http_client =
+          MmJsonClient::HttpClient::Client.new(base_url, options[:endpoint],
+                                               allowed_client_options(options))
+      end
+
+      # id defaults to false to detect if was specified. Null is a valid value
+      # according to the spec.
+      def request(method, params = nil, id = false)
+        http_response = @http_client.post(request_message(method, params, id))
+        MmJsonClient::JsonRpcHttp::Response.new(http_response.body)
+      end
+
+      private
+
+      def base_request_message
+        { jsonrpc: '2.0' }
+      end
+
+      def request_message(method, params, id)
+        msg = base_request_message.merge(method: method, params: params)
+        msg[:id] = id unless id == false # Optional
+        msg.to_json
+      end
+
+      def allowed_client_options(options)
+        allowed = [:verify_ssl, :open_timeout, :timeout]
+        options.select { |option| allowed.include?(option) }
+      end
+    end
+  end
+end

data/lib/mm_json_client/json_rpc_http/error.rb

@@ -0,0 +1,18 @@
+require 'json'
+
+module MmJsonClient
+  module JsonRpcHttp
+    # A standard formatted JSON-RPC error.
+    class Error
+      attr_reader :code
+      attr_reader :data
+      attr_reader :message
+
+      def initialize(data)
+        @code = data['code']
+        @data = data['data']
+        @message = data['message']
+      end
+    end
+  end
+end

data/lib/mm_json_client/json_rpc_http/exceptions.rb

@@ -0,0 +1,10 @@
+module MmJsonClient
+  module JsonRpcHttp
+    # The server responded with an invalid message format.
+    class InvalidResponseFormat < StandardError
+      def initialize(message = 'Server response format is invalid.')
+        super(message)
+      end
+    end
+  end
+end

data/lib/mm_json_client/json_rpc_http/response.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'mm_json_client/json_rpc_http/exceptions'
+require 'mm_json_client/json_rpc_http/error'
+
+module MmJsonClient
+  module JsonRpcHttp
+    # A standard formatted JSON-RPC response.
+    class Response
+      attr_reader :error
+      attr_reader :id
+      attr_reader :result
+      attr_reader :version
+
+      def initialize(json)
+        data = JSON.parse(json)
+        @version = data['version']
+        @result = data['result']
+        @error = data['error'] && new_error(data['error'])
+        @id = data['id']
+      rescue JSON::ParserError
+        raise InvalidResponseFormat
+      end
+
+      private
+
+      def new_error(error_data)
+        MmJsonClient::JsonRpcHttp::Error.new(error_data)
+      end
+    end
+  end
+end

data/lib/mm_json_client/response_code.rb

@@ -0,0 +1,6 @@
+module MmJsonClient
+  module ResponseCode
+    REQUESTS_DISABLED = 1037
+    INVALID_LOGIN = 16394
+  end
+end

data/lib/mm_json_client/type_factory.rb

@@ -0,0 +1,83 @@
+require 'mm_json_client/generic_type'
+
+module MmJsonClient
+  # Dynamically create types and simplify their instantiation.
+  class TypeFactory
+    @types = {}
+
+    # Create type classes for the api definition.
+    def self.load_types(types = {})
+      types.each { |type, definition| define(type, definition) }
+    end
+
+    def self.build_from_data(type_name, data = {})
+      return build_array_type(type_name, data) if data.class == Array
+      return build_simple_type(type_name, data) if simple_type?(type_name)
+      build_complex_type(type_name, data)
+    end
+
+    class << self
+      attr_reader :types
+
+      private
+
+      def define(type_name, definition)
+        if definition.class == Array
+          add_type_definition(type_name, definition)
+        else
+          snaked_definition = definition.mm_underscore_keys
+          add_type_definition(type_name, snaked_definition)
+
+          klass = Class.new(MmJsonClient::GenericType) do
+            snaked_definition.each { |attribute, _type| property attribute }
+          end
+
+          MmJsonClient.const_set type_class_name(type_name), klass
+        end
+      end
+
+      def build_array_type(type_name, data)
+        array_type = type_definition(type_name).first
+        data.map { |d| build_from_data(array_type, d) }
+      end
+
+      def build_simple_type(_type_name, data)
+        data
+      end
+
+      def build_complex_type(type_name, data)
+        MmJsonClient.const_get(type_class_name(type_name)).new.tap do |obj|
+          type_def = type_definition(type_name)
+          data.each do |attr_name, value|
+            subtype = type_def[attr_name]
+            obj.send("#{attr_name}=", build_from_data(subtype, value))
+          end
+        end
+      end
+
+      # TODO: Find a way to consistently deal with weirdly cased items like
+      # this. Since we won't be sending the type name into the API this
+      # conversion is currently ok.
+      def type_class_name(type_name)
+        return type_name if type_name[0].upcase == type_name[0]
+        "#{type_name[0].upcase}#{type_name[1..-1]}"
+      end
+
+      def type_defined?(type_name)
+        types.include?(type_name)
+      end
+
+      def add_type_definition(type_name, definition)
+        @types[type_name] = definition
+      end
+
+      def type_definition(type_name)
+        types[type_name]
+      end
+
+      def simple_type?(type_name)
+        !type_defined?(type_name)
+      end
+    end
+  end
+end

data/lib/mm_json_client/version.rb

@@ -0,0 +1,3 @@
+module MmJsonClient
+  VERSION = '0.1.0'.freeze
+end

data/mm_json_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mm_json_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mm_json_client'
+  spec.version       = MmJsonClient::VERSION
+  spec.authors       = ['Eric Wannemacher']
+  spec.email         = ['eric@wannemacher.us']
+
+  spec.summary       = 'A client gem for Men & Mice IPAM via JSON-RPC'
+  spec.homepage      = 'https://github.com/ewannema/mm_json_client'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Force listen (required by guard) to be a Ruby 2.0.0 compatible version.
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'listen', '~> 2.0'
+
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  # Wasabi requires httpi which requires rack which is pulling 2.0+ and breaks
+  # on < 2.2 Rubies. We will require a compatible rack for now and come back
+  # to check on https://github.com/bundler/bundler/pull/4650
+  spec.add_development_dependency 'wasabi'
+  spec.add_development_dependency 'rack', '~>1.6'
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: mm_json_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Wannemacher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: wasabi
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- eric@wannemacher.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/claim_next_free_ip.rb
+- examples/register_dns.rb
+- examples/release_ip.rb
+- examples/unregister_dns.rb
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/basic_server_interaction/allows_a_user_to_log_in_and_out.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/basic_server_interaction/filters_a_list_of_users.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/basic_server_interaction/gets_a_list_of_users.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/basic_server_interaction/gets_a_user_by_reference.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/basic_server_interaction/responds_with_a_server_error_on_bad_auth.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/multiple_proxy_servers/connects_to_another_proxy_when_one_is_disabled.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/proxy_options/allows_a_separate_proxy_to_be_defined.yml
+- fixtures/vcr_cassettes/MmJsonClient_GenericType/ssl_options/allows_ignoring_bad_certificates.yml
+- generators/enum_def_generator.rb
+- generators/method_def_generator.rb
+- generators/type_def_generator.rb
+- generators/wasabi_extension.rb
+- lib/core_ext/hash_extension.rb
+- lib/core_ext/string_extension.rb
+- lib/core_ext/symbol_extension.rb
+- lib/mm_json_client.rb
+- lib/mm_json_client/api_definitions/enums.json
+- lib/mm_json_client/api_definitions/methods.json
+- lib/mm_json_client/api_definitions/types.json
+- lib/mm_json_client/client.rb
+- lib/mm_json_client/enums/enum_factory.rb
+- lib/mm_json_client/enums/generic_enum.rb
+- lib/mm_json_client/exceptions.rb
+- lib/mm_json_client/generic_type.rb
+- lib/mm_json_client/http_client/client.rb
+- lib/mm_json_client/json_rpc_http/client.rb
+- lib/mm_json_client/json_rpc_http/error.rb
+- lib/mm_json_client/json_rpc_http/exceptions.rb
+- lib/mm_json_client/json_rpc_http/response.rb
+- lib/mm_json_client/response_code.rb
+- lib/mm_json_client/type_factory.rb
+- lib/mm_json_client/version.rb
+- mm_json_client.gemspec
+homepage: https://github.com/ewannema/mm_json_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A client gem for Men & Mice IPAM via JSON-RPC
+test_files: []