jsonism 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5974d3d075706ced2dba0cbf08836c273631104
-  data.tar.gz: 904c1343e967ecb95335eaba195a6f11e4cae904
+  metadata.gz: 7e52cd62c6c50669db16bc69bc716d183d6e5ef6
+  data.tar.gz: 85895e83b5b2a28d6ff44e639a18a22f6e8d2d6c
 SHA512:
-  metadata.gz: ff268a39733452a783f162a646e9772fc8351bd3221b0de026837955b1f3e1d017564b43220e40db11337888f6ae8d6fbc6699fcf8c74180dec12f314527ab05
-  data.tar.gz: e75a3f4eb5072fac3ab3e18b52f7b2d2df28a3aa833c5acfec5292f5935fa5d8273253483d11dcde331e584991475d9acd736d079b9e0f19dbdf113bc7ff69d1
+  metadata.gz: a8151d1bfd6ce0f815ab3e1980c7645c93d48dd41d02b07976785eace90beab9baa0639d70ec387224eef39959f29296ca95e9cb49baecd43638ef43f55423f9
+  data.tar.gz: 30dbc50cd609e3ccd6f15ae81d580eba75688734a2841cca93b1a64d02d9aff0c2a51cf007dbf650906b09d84161eaf8519c959f8e6611415f82cde903b06f57

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+* Define resource.delete & resource.update methods if correspondent links are defined
+
+## 0.0.1
+* 1st release

data/README.md

@@ -20,7 +20,7 @@ client.info_app(id: 1)
 # POST /apps
 client.create_app(name: "alpha")
 
-# PUT /apps/1
+# PATCH /apps/1
 client.update_app(id: 1, name: "bravo")
 
 # DELETE /apps/1
@@ -28,6 +28,35 @@ client.delete_app(id: 1)
 
 # GET /recipes
 client.list_recipe
+
+# Each method returns a Jsonism::Response
+client.list_app.class #=> Jsonism::Response
+
+# Jsonism::Response has 3 methods: .status, .headers, .body
+client.list_app.status #=> 200
+client.list_app.headers["Content-Type"] #=> "application/json"
+client.list_app.body #=> [#<Jsonism::Resources::App:0x007f871ec96240>]
+
+# Jsonism::Response#body returns an instance of auto-defined class, or ones wrapped in Array
+# This class name is assigned from its title property on JSON Schema
+client.list_app.body[0].class #=> Jsonism::Resources::App
+client.info_app(id: 1).body.class #=> Jsonism::Resources::App
+
+# Auto-defined resource class inherits from Jsonism::Resources::Base
+client.list_app.body[0].class.ancestors[1] #=> Jsonism::Resources::Base
+
+# Jsonism::Resources::Base has a method: .to_hash
+client.list_app.body[0].to_hash #=> {"id"=>"01234567-89ab-cdef-0123-456789abcdef", "name"=>"example"}
+
+# Resource can respond to .delete method if a link with rel=delete is defined in schema
+# DELETE /apps/1
+client.info_app.body[0].body.delete
+
+# Resource can also respond to .update method in the same rule
+# PATCH /apps/1
+resource = client.info_app.body[0]
+resource.name = "charlie"
+resource.update
 ```
 
 ## Errors

data/jsonism.gemspec

@@ -21,6 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "json_schema"
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack-json_schema"
   spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "webmock"
 end

data/lib/jsonism.rb

@@ -1,3 +1,4 @@
+require "active_support/concern"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/hash/keys"
 require "active_support/core_ext/hash/slice"
@@ -13,4 +14,8 @@ require "jsonism/client"
 require "jsonism/definer"
 require "jsonism/link"
 require "jsonism/request"
+require "jsonism/resources/base"
+require "jsonism/resources/deletable"
+require "jsonism/resources/updatable"
+require "jsonism/response"
 require "jsonism/version"

data/lib/jsonism/client.rb

@@ -23,6 +23,13 @@ module Jsonism
       @base_url ||= root_link.try(:href) or raise BaseUrlNotFound
     end
 
+    # @return [Hash<String, Class>]
+    # @example
+    #   resource_classes #=> { "App" #=> #<Class> }
+    def resource_classes
+      @resource_classes ||= {}
+    end
+
     private
 
     # Defines some methods into itself from its JSON Schema

data/lib/jsonism/definer.rb

@@ -22,12 +22,8 @@ module Jsonism
 
     # 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
+      define_methods_into(@client)
+      define_classes
     end
 
     private
@@ -38,5 +34,54 @@ module Jsonism
         Link.new(link: link)
       end
     end
+
+    def define_classes
+      @schema.properties.each do |name, schema|
+        unless Resources.const_defined?(name.camelize)
+          Resources.const_set(
+            name.camelize,
+            Class.new(Resources::Base) do
+              schema.properties.each do |name, schema|
+                define_method(name) do
+                  @properties[name]
+                end
+
+                if schema.read_only
+                  read_only_property name
+                else
+                  define_method("#{name}=") do |value|
+                    change(name, value) if @properties[name] != value
+                  end
+                end
+              end
+
+              schema.links.each do |link|
+                if link.rel == "delete"
+                  include Resources::Deletable
+                  self.link_for_deletion = Link.new(link: link)
+                end
+
+                if link.rel == "update"
+                  include Resources::Updatable
+                  self.link_for_update = Link.new(link: link)
+                end
+              end
+            end
+          )
+        end
+      end
+    end
+
+    # Defines methods into client
+    # @example
+    #   client.list_app
+    #   client.info_app(id: 1)
+    def define_methods_into(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
   end
 end

data/lib/jsonism/link.rb

@@ -26,12 +26,12 @@ module Jsonism
       @link.href
     end
 
-    private
-
     def schema_title
       schema.title
     end
 
+    private
+
     def link_title
       @link.title
     end

data/lib/jsonism/request.rb

@@ -9,17 +9,23 @@ module Jsonism
     # @param headers [Hash]
     # @param link [Jsonism::Link]
     # @param params [Hash]
-    def initialize(client: nil, headers: {}, link: nil, params: {})
+    # @param options [Hash] Options to change the default behavior
+    def initialize(client: nil, headers: {}, link: nil, params: {}, **options)
       @client = client
       @headers = headers
       @link = link
       @params = params.with_indifferent_access
+      @options = options
     end
 
     # Sends HTTP request
     def call
       if has_valid_params?
-        @client.connection.send(method, path)
+        Response.new(
+          client: @client,
+          resource_class: resource_class,
+          response: @client.connection.send(method, path),
+        )
       else
         raise MissingParams, missing_params
       end
@@ -27,6 +33,15 @@ module Jsonism
 
     private
 
+    # @return [Class] Auto-defined resource class
+    def resource_class
+      Resources.const_get(resource_class_name)
+    end
+
+    def resource_class_name
+      @link.schema_title.camelize
+    end
+
     # @return [true, false] False if any keys in path template are missing
     def has_valid_params?
       missing_params.empty?
@@ -37,6 +52,13 @@ module Jsonism
       @missing_params ||= path_keys - @params.keys
     end
 
+    # @return [Array<String>] Parameter names marked as readonly
+    def read_only_params
+      @read_only_params ||= @link.schema.properties.map do |name, property|
+        name if property.read_only
+      end.compact
+    end
+
     # @return [String] Method name to call connection's methods
     # @example
     #   method #=> "get"
@@ -81,7 +103,13 @@ module Jsonism
     # @example
     #   request_params #=> { name: "example" }
     def request_params
-      @params.except(*path_keys)
+      unless configured_to_ignore_request_params?
+        @params.except(*path_keys, *read_only_params)
+      end
+    end
+
+    def configured_to_ignore_request_params?
+      p !!@options[:ignore_request_params]
     end
 
     class MissingParams < Error

data/lib/jsonism/resources/base.rb

@@ -0,0 +1,52 @@
+module Jsonism
+  module Resources
+    class Base
+      class << self
+        def read_only_property(name)
+          read_only_properties << name
+        end
+
+        def read_only_properties
+          @read_only_properties ||= []
+        end
+      end
+
+      # @param client [Jsonism::Client]
+      # @param properties [Hash]
+      def initialize(client: nil, properties: nil)
+        @client = client
+        @properties = properties
+      end
+
+      def to_hash
+        @properties.clone
+      end
+
+      def changed?
+        !changed_properties.empty?
+      end
+
+      def save
+        @previously_changed_properties = changed_properties
+        @changed_properties = {}
+      end
+
+      def change(name, value)
+        changed_properties[name] = value
+        @properties[name] = value
+      end
+
+      def changed_properties
+        @changed_properties ||= {}
+      end
+
+      def previously_changed_properties
+        @previously_changed_properties ||= {}
+      end
+
+      def read_only_properties
+        to_hash.slice(*self.class.read_only_properties)
+      end
+    end
+  end
+end

data/lib/jsonism/resources/deletable.rb

@@ -0,0 +1,21 @@
+module Jsonism
+  module Resources
+    module Deletable
+      extend ActiveSupport::Concern
+
+      def delete(params = {}, headers = {})
+        Request.call(
+          client: @client,
+          headers: headers,
+          link: self.class.link_for_deletion,
+          params: to_hash,
+          ignore_request_params: true,
+        )
+      end
+
+      module ClassMethods
+        attr_accessor :link_for_deletion
+      end
+    end
+  end
+end

data/lib/jsonism/resources/updatable.rb

@@ -0,0 +1,20 @@
+module Jsonism
+  module Resources
+    module Updatable
+      extend ActiveSupport::Concern
+
+      def update(params = {}, headers = {})
+        Request.call(
+          client: @client,
+          headers: headers,
+          link: self.class.link_for_update,
+          params: read_only_properties.merge(changed_properties.merge(params)),
+        )
+      end
+
+      module ClassMethods
+        attr_accessor :link_for_update
+      end
+    end
+  end
+end

data/lib/jsonism/response.rb

@@ -0,0 +1,40 @@
+module Jsonism
+  class Response
+    # @param client [Jsonism::Client]
+    # @param resource_class [Class]
+    # @param response [Faraday::Response]
+    def initialize(client: nil, resource_class: nil, response: nil)
+      @client = client
+      @resource_class = resource_class
+      @response = response
+    end
+
+    def body
+      if has_list?
+        @response.body.map do |properties|
+          @resource_class.new(client: @client, properties: properties)
+        end
+      else
+        @resource_class.new(client: @client, properties: @response.body)
+      end
+    end
+
+    def headers
+      @response.headers
+    end
+
+    def status
+      @response.status
+    end
+
+    private
+
+    def has_list?
+      Array === @response.body
+    end
+
+    def raw_body
+      @response.body
+    end
+  end
+end

data/lib/jsonism/version.rb

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

data/spec/fixtures/schema.json

@@ -52,7 +52,7 @@
           "description": "Delete an existing app.",
           "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fid)}",
           "method": "DELETE",
-          "rel": "destroy",
+          "rel": "delete",
           "title": "Delete"
         },
         {

data/spec/jsonism/client_spec.rb

@@ -1,6 +1,18 @@
 require "spec_helper"
 
 describe Jsonism::Client do
+  before do
+    stub_request(:any, //).to_rack(mock_app)
+  end
+
+  let(:mock_app) do
+    local_schema = schema
+    Rack::Builder.new do
+      use Rack::JsonSchema::Mock, schema: local_schema
+      run ->(env) { [404, {}, ["Not Found"]] }
+    end
+  end
+
   let(:instance) do
     described_class.new(schema: schema)
   end
@@ -17,6 +29,10 @@ describe Jsonism::Client do
     File.expand_path("../../fixtures/schema.json", __FILE__)
   end
 
+  let(:params) do
+    { id: 1 }
+  end
+
   describe ".new" do
     subject do
       instance
@@ -41,9 +57,16 @@ describe Jsonism::Client do
       instance.list_app
     end
 
-    it "sends HTTP request to GET /apps" do
-      instance.connection.should_receive(:get).with("/apps")
-      subject
+    context "with valid condition" do
+      it "sends HTTP request to GET /apps" do
+        instance.connection.should_receive(:get).with("/apps")
+        subject
+      end
+
+      it "returns an Array of resources" do
+        subject.body.should be_a Array
+        subject.body[0].should be_a Jsonism::Resources::App
+      end
     end
   end
 
@@ -52,15 +75,21 @@ describe Jsonism::Client 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
+
+      it "returns a Jsonism::Response" do
+        should be_a Jsonism::Response
+      end
+
+      it "returns status, headers, and body data" do
+        subject.status.should == 200
+        subject.headers.should be_a Hash
+        subject.body.should be_a Jsonism::Resources::App
+      end
     end
 
     context "with missing params" do
@@ -73,4 +102,45 @@ describe Jsonism::Client do
       end
     end
   end
+
+  describe "#delete_app" do
+    let(:resource) do
+      instance.info_app(params).body
+    end
+
+    context "with valid condition" do
+      it "sends HTTP request to DELETE /apps/:id" do
+        instance.connection.should_receive(:delete).with("/apps/1")
+        instance.delete_app(params)
+      end
+    end
+
+    context "via app.delete" do
+      it "can be called from app.delete too" do
+        instance.connection.should_receive(:delete).with("/apps/#{resource.id}")
+        resource.delete
+      end
+    end
+  end
+
+  describe "#update_app" do
+    let(:resource) do
+      instance.info_app(params).body
+    end
+
+    context "with valid condition" do
+      it "sends HTTP request to PATCH /apps/:id" do
+        instance.connection.should_receive(:patch).with("/apps/1")
+        instance.update_app(params)
+      end
+    end
+
+    context "via app.update" do
+      it "can be called from app.update too" do
+        instance.connection.should_receive(:patch).with("/apps/#{resource.id}")
+        resource.name = "bravo"
+        resource.update
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
 require "jsonism"
+require "rack"
+require "rack/json_schema"
+require "webmock/rspec"
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonism
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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-json_schema
+  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
@@ -108,6 +150,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.14.1
+- !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: 
 email:
 - r7kamura@gmail.com
@@ -116,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -127,6 +184,10 @@ files:
 - lib/jsonism/error.rb
 - lib/jsonism/link.rb
 - lib/jsonism/request.rb
+- lib/jsonism/resources/base.rb
+- lib/jsonism/resources/deletable.rb
+- lib/jsonism/resources/updatable.rb
+- lib/jsonism/response.rb
 - lib/jsonism/version.rb
 - spec/fixtures/schema.json
 - spec/jsonism/client_spec.rb