jsonism 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5974d3d075706ced2dba0cbf08836c273631104
+  data.tar.gz: 904c1343e967ecb95335eaba195a6f11e4cae904
+SHA512:
+  metadata.gz: ff268a39733452a783f162a646e9772fc8351bd3221b0de026837955b1f3e1d017564b43220e40db11337888f6ae8d6fbc6699fcf8c74180dec12f314527ab05
+  data.tar.gz: e75a3f4eb5072fac3ab3e18b52f7b2d2df28a3aa833c5acfec5292f5935fa5d8273253483d11dcde331e584991475d9acd736d079b9e0f19dbdf113bc7ff69d1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+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,42 @@
+# Jsonism
+Generate HTTP Client from JSON Schema.
+
+## Usage
+```ruby
+# Prepare JSON Schema for your API
+body = File.read("schema.json")
+schema = JSON.parse(body)
+
+# Create an HTTP client from JSON Schema which is a Hash object
+client = Jsonism::Client.new(schema: schema)
+client.methods(false) #=> [:create_app, :delete_app, :info_app, :list_app, :update_app, :list_recipe]
+
+# GET /apps
+client.list_app
+
+# GET /apps/1
+client.info_app(id: 1)
+
+# POST /apps
+client.create_app(name: "alpha")
+
+# PUT /apps/1
+client.update_app(id: 1, name: "bravo")
+
+# DELETE /apps/1
+client.delete_app(id: 1)
+
+# GET /recipes
+client.list_recipe
+```
+
+## Errors
+```
+StandardError
+|
+`---Jsonism::Error
+    |
+    |---Jsonism::Client::BaseUrlNotFound
+    |
+    `---Jsonism::Request::MissingParams
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jsonism.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jsonism/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonism"
+  spec.version       = Jsonism::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Generate HTTP Client from JSON Schema."
+  spec.homepage      = "https://github.com/r7kamura/jsonism"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json_schema"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+end

data/lib/jsonism.rb

@@ -0,0 +1,16 @@
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/slice"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/inflections"
+require "faraday"
+require "faraday_middleware"
+require "json"
+require "json_schema"
+
+require "jsonism/error"
+require "jsonism/client"
+require "jsonism/definer"
+require "jsonism/link"
+require "jsonism/request"
+require "jsonism/version"

data/lib/jsonism/client.rb

@@ -0,0 +1,44 @@
+module Jsonism
+  class Client
+    # @param schema [Hash] JSON Schema
+    # @raise [JsonSchema::SchemaError]
+    def initialize(schema: nil)
+      @schema = ::JsonSchema.parse!(schema).tap(&:expand_references!)
+      define
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(url: base_url) do |connection|
+        connection.request :json
+        connection.response :json
+        connection.adapter :net_http
+      end
+    end
+
+    # @return [String] Base URL of API
+    # @note Base URL is gained from the top-level link property whose `rel` is self
+    # @raise [Jsonism::Client::BaseUrlNotFound]
+    def base_url
+      @base_url ||= root_link.try(:href) or raise BaseUrlNotFound
+    end
+
+    private
+
+    # Defines some methods into itself from its JSON Schema
+    def define
+      Definer.call(client: self, schema: @schema)
+    end
+
+    # Finds link that has "self" rel to resolve API base URL
+    # @return [JsonSchema::Schema::Link, nil]
+    def root_link
+      @schema.links.find do |link|
+        link.rel == "self"
+      end
+    end
+
+    class BaseUrlNotFound < Error
+    end
+  end
+end

data/lib/jsonism/definer.rb

@@ -0,0 +1,42 @@
+module Jsonism
+  class Definer
+    # Utility wrapper
+    def self.call(*args)
+      new(*args).call
+    end
+
+    # Recursively extracts all links from given JSON schema
+    # @param schema [JsonSchema::Schema]
+    # @return [Array<JsonSchema::Schema::Link>]
+    def self.extract_links(schema)
+      links = schema.links.select {|link| link.method && link.href }
+      links + schema.properties.map {|key, schema| extract_links(schema) }.flatten
+    end
+
+    # @param client [Jsonism::Client]
+    # @param schema [JsonSchema::Schema] JSON Schema
+    def initialize(client: nil, schema: nil)
+      @client = client
+      @schema = schema
+    end
+
+    # Defines methods to call HTTP request from its JSON schema
+    def call
+      client = @client
+      links.each do |link|
+        @client.define_singleton_method(link.method_signature) do |params = {}, headers = {}|
+          Request.call(client: client, headers: headers, link: link, params: params)
+        end
+      end
+    end
+
+    private
+
+    # @return [Array<JsonSchema::Schema::Link>] Links defined in its JSON schema
+    def links
+      @links ||= self.class.extract_links(@schema).map do |link|
+        Link.new(link: link)
+      end
+    end
+  end
+end

data/lib/jsonism/error.rb

@@ -0,0 +1,4 @@
+module Jsonism
+  class Error < StandardError
+  end
+end

data/lib/jsonism/link.rb

@@ -0,0 +1,43 @@
+module Jsonism
+  class Link
+    # @param schema [JsonSchema::Schema::Link]
+    def initialize(link: nil)
+      @link = link
+    end
+
+    # @return [String]
+    # @example
+    #   method_signature #=> "list_app"
+    def method_signature
+      link_title.underscore + "_" + schema_title.gsub(" ", "").underscore
+    end
+
+    # @return [String] Uppercase requet method
+    # @example
+    #   method #=> "GET"
+    def method
+      @link.method.to_s.upcase
+    end
+
+    # @return [Stirng]
+    # @example
+    #   href #=> "/apps"
+    def href
+      @link.href
+    end
+
+    private
+
+    def schema_title
+      schema.title
+    end
+
+    def link_title
+      @link.title
+    end
+
+    def schema
+      @link.target_schema || @link.parent
+    end
+  end
+end

data/lib/jsonism/request.rb

@@ -0,0 +1,97 @@
+module Jsonism
+  class Request
+    # Utility wrapper
+    def self.call(*args)
+      new(*args).call
+    end
+
+    # @param client [Jsonism::Client]
+    # @param headers [Hash]
+    # @param link [Jsonism::Link]
+    # @param params [Hash]
+    def initialize(client: nil, headers: {}, link: nil, params: {})
+      @client = client
+      @headers = headers
+      @link = link
+      @params = params.with_indifferent_access
+    end
+
+    # Sends HTTP request
+    def call
+      if has_valid_params?
+        @client.connection.send(method, path)
+      else
+        raise MissingParams, missing_params
+      end
+    end
+
+    private
+
+    # @return [true, false] False if any keys in path template are missing
+    def has_valid_params?
+      missing_params.empty?
+    end
+
+    # @return [Array<Stirng>] Missing parameter names
+    def missing_params
+      @missing_params ||= path_keys - @params.keys
+    end
+
+    # @return [String] Method name to call connection's methods
+    # @example
+    #   method #=> "get"
+    def method
+      @link.method.downcase
+    end
+
+    # @return [String] Path whose URI template is resolved
+    # @example
+    #   path #=> "/apps/1"
+    def path
+      path_with_template % path_params.symbolize_keys
+    end
+
+    # @return [String]
+    # @example
+    #   path_with_template #=> "/apps/%{id}"
+    def path_with_template
+      @link.href.gsub(/{(.+)}/) do |matched|
+        key = CGI.unescape($1).gsub(/[()]/, "").split("/").last
+        "%{#{key}}"
+      end
+    end
+
+    # @return [Array<String>] Parameter names required for path
+    # @exmaple
+    #   path_keys #=> ["id"]
+    def path_keys
+      @link.href.scan(/{(.+)}/).map do |str|
+        CGI.unescape($1).gsub(/[()]/, "").split("/").last
+      end
+    end
+
+    # @return [ActiveSupport::HashWithIndifferentAccess] Params to be embedded into path
+    # @example
+    #   path_params #=> { id: 1 }
+    def path_params
+      @params.slice(*path_keys)
+    end
+
+    # @return [ActiveSupport::HashWithIndifferentAccess] Params to be used for request body or query string
+    # @example
+    #   request_params #=> { name: "example" }
+    def request_params
+      @params.except(*path_keys)
+    end
+
+    class MissingParams < Error
+      def initialize(missing_params)
+        @missing_params = missing_params
+      end
+
+      def to_s
+        @missing_params.join(", ") + " params are missing"
+      end
+    end
+  end
+end

data/lib/jsonism/version.rb

@@ -0,0 +1,3 @@
+module Jsonism
+  VERSION = "0.0.1"
+end

data/spec/fixtures/schema.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "http://json-schema.org/draft-04/hyper-schema",
+  "definitions": {
+    "app": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "description": "An app is a program to be deployed.",
+      "id": "schemata/app",
+      "title": "App",
+      "type": [
+        "object"
+      ],
+      "required": ["id"],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of app",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "name": {
+          "description": "unique name of app",
+          "example": "example",
+          "pattern": "^[a-z][a-z0-9-]{3,50}$",
+          "readOnly": false,
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Create a new app.",
+          "href": "/apps",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/app/definitions/name"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Create"
+        },
+        {
+          "description": "Delete an existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "title": "Delete"
+        },
+        {
+          "description": "Info for existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Info"
+        },
+        {
+          "description": "List existing apps.",
+          "href": "/apps",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        },
+        {
+          "description": "Update an existing app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
+          "method": "PATCH",
+          "rel": "update",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/app/definitions/name"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Update"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/app/definitions/id"
+        },
+        "name": {
+          "$ref": "#/definitions/app/definitions/name"
+        }
+      }
+    },
+    "recipe": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "description": "cooking Recipe",
+      "title": "Recipe",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of recipe",
+          "format": "uuid",
+          "readOnly": true,
+          "example": 1,
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "List recipes",
+          "href": "/recipes",
+          "method": "GET",
+          "rel": "instances",
+          "title": "list"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/recipe/definitions/id"
+        }
+      }
+    }
+  },
+  "properties": {
+    "app": {
+      "$ref": "#/definitions/app"
+    },
+    "recipe": {
+      "$ref": "#/definitions/recipe"
+    }
+  },
+  "type": [
+    "object"
+  ],
+  "description": "A schema for a small example API.",
+  "links": [
+    {
+      "href": "http://localhost:8080",
+      "rel": "self"
+    }
+  ],
+  "title": "Example API"
+}

data/spec/jsonism/client_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Jsonism::Client do
+  let(:instance) do
+    described_class.new(schema: schema)
+  end
+
+  let(:schema) do
+    JSON.parse(schema_body)
+  end
+
+  let(:schema_body) do
+    File.read(schema_path)
+  end
+
+  let(:schema_path) do
+    File.expand_path("../../fixtures/schema.json", __FILE__)
+  end
+
+  describe ".new" do
+    subject do
+      instance
+    end
+
+    it "creates a new Jsonism::Client from given JSON Schema" do
+      should be_a described_class
+    end
+
+    it "defines some methods from links property" do
+      should be_respond_to :create_app
+      should be_respond_to :delete_app
+      should be_respond_to :info_app
+      should be_respond_to :list_app
+      should be_respond_to :list_recipe
+      should be_respond_to :update_app
+    end
+  end
+
+  describe "#list_app" do
+    subject do
+      instance.list_app
+    end
+
+    it "sends HTTP request to GET /apps" do
+      instance.connection.should_receive(:get).with("/apps")
+      subject
+    end
+  end
+
+  describe "#info_app" do
+    subject do
+      instance.info_app(params)
+    end
+
+    let(:params) do
+      { id: 1 }
+    end
+
+    context "with valid condition" do
+      it "sends HTTP request to GET /apps/:id" do
+        instance.connection.should_receive(:get).with("/apps/1")
+        subject
+      end
+    end
+
+    context "with missing params" do
+      before do
+        params.delete(:id)
+      end
+
+      it "raises Jsonism::Request::MissingParams" do
+        expect { subject }.to raise_error(Jsonism::Request::MissingParams, "id params are missing")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "jsonism"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: jsonism
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jsonism.gemspec
+- lib/jsonism.rb
+- lib/jsonism/client.rb
+- lib/jsonism/definer.rb
+- lib/jsonism/error.rb
+- lib/jsonism/link.rb
+- lib/jsonism/request.rb
+- lib/jsonism/version.rb
+- spec/fixtures/schema.json
+- spec/jsonism/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/jsonism
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generate HTTP Client from JSON Schema.
+test_files:
+- spec/fixtures/schema.json
+- spec/jsonism/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: