json_client 0.0.2 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7cb4bba261119f65721f26b628f479a38e75f51
-  data.tar.gz: 22b36d3aed2ef8d04dc893b687fc2e41cb4d9267
+  metadata.gz: 702dbe914a769256fa420b376e62097b91f8cc2b
+  data.tar.gz: 0fa43e21e5dbfec83ca99537f3d9d16089fd6edf
 SHA512:
-  metadata.gz: 6bf62b6375988b27e103251979fa0127b6a08882b9d46c57726f32ce088c0323dfa5264dc375a9ff9fa7de213c1f1cf8b684085603cfd6c7f2d4db59ecbb504d
-  data.tar.gz: a860985b6ffdbf33c15fb8cfd94928aa85712ccbe099b3686f2cbf300f1575be21d8a6d78e4b93cb20be792a729cffb0fc41f774e950b0827e34e946cf0f4291
+  metadata.gz: 32833898addf3fd748f79681cfbf77542768233f24c77f2dacdee05c0c5e0c7d5a9b06b74c8e6016c252e4f91a439be6a046ee7fe048780bca887d6df7daa991
+  data.tar.gz: bdfabe4c865a9461d59a83adceb325f527e214e3dc5450397278d67222624b4ed754d69022141e633db59bc7c5f3a43721f33bc5c7b0632b499e0b8863bd9f49

data/README.md

@@ -1,4 +1,6 @@
 # JsonClient
+[![Gem
+Version](https://badge.fury.io/rb/json_client.svg)](http://badge.fury.io/rb/json_client)
 [![Build
 Status](https://travis-ci.org/johnmcconnell/json_client.svg?branch=master)](https://travis-ci.org/johnmcconnell/json_client)
 [![Coverage
@@ -52,23 +54,20 @@ config = {
   api_password: 'api_password'
 }
 
-
 client = Client.new(config)
 
 # GET https://example.host.com/api/v1/objects?api_key=api_key&api_password=api_password
 client.index.json
  => { 'server_json' : 'is_parsed_here' }
 
-
-
 # GET https://my.host.com/api/v1/objects/2?api_key=api_key&api_password=api_password
-client.show(2).json # fetches from
+client.show(2).json
  => { 'object_json' : 'is_parsed_here' }
 ```
 
 ## Best Guide
 
-Is [this
+The best guide is [this
 test](https://github.com/johnmcconnell/json_client/blob/master/spec/json_client/base_spec.rb).
 Sorry non rspec people
 

data/json_client.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rest-client', '~> 1.7.2'
+  spec.add_dependency 'attr_init', '~> 0.0.4'
 
   spec.add_development_dependency "simplecov", "~> 0.8.0"
   spec.add_development_dependency "coveralls", "~> 0.7.0"

data/lib/json_client.rb

@@ -1,6 +1,7 @@
 require "json_client/version"
 require "json_client/base"
 require "json_client/pather"
+require "json_client/dsl"
 
 module JsonClient
   def self.new(pather, config)

data/lib/json_client/base.rb

@@ -1,11 +1,47 @@
 require 'rest_client'
+
+require 'json_client/dsl'
 require 'json_client/responses'
 require 'json_client/requests'
+require 'json_client/base_serializer'
+require 'json_client/empty_serializer'
+require 'json_client/base_requests/index'
+require 'json_client/base_requests/show'
+require 'json_client/base_requests/create'
+require 'json_client/base_requests/update'
+require 'json_client/base_requests/destroy'
+require 'json_client/base_responses/index'
+require 'json_client/base_responses/show'
+require 'json_client/base_responses/create'
+require 'json_client/base_responses/update'
+require 'json_client/base_responses/destroy'
 
 module JsonClient
   class Base
+    extend DSL
     attr_reader :api_key, :api_password, :pather
 
+    requests do |r|
+      r.on :index, use: BaseRequests::Index.new
+      r.on :show, use: BaseRequests::Show.new
+      r.on :create, use: BaseRequests::Create.new
+      r.on :update, use: BaseRequests::Update.new
+      r.on :destroy, use: BaseRequests::Destroy.new
+    end
+
+    responses do |r|
+      r.on :index, use: BaseResponses::Index
+      r.on :show, use: BaseResponses::Show
+      r.on :create, use: BaseResponses::Create
+      r.on :update, use: BaseResponses::Update
+      r.on :destroy, use: BaseResponses::Destroy
+    end
+
+    serializers do |s|
+      s.on :create, :update, :destroy, use: BaseSerializer.new
+      s.on :index, :show, use: EmptySerializer.new
+    end
+
     def initialize(pather, config)
       @api_key = config[:api_key]
       @api_password = config[:api_password]
@@ -14,52 +50,42 @@ module JsonClient
     end
 
     def index
-      response = requestors.index.new.fetch(request_path, auth_params)
-      responders.index.new(response.body, response.code)
+      result(:index, nil)
     end
 
     def show(id)
-      response = requestors.show.new.fetch(request_path(id), auth_params)
-      responders.show.new(response.body, response.code)
+      result(:show, nil, id)
     end
 
     def create(model)
-      response = requestors.create.new.fetch(
-        request_path, auth_params, model
-      )
-      responders.create.new(response.body, response.code)
+      result(:create, model)
     end
 
     def update(id, model)
-      response = requestors.update.new.fetch(
-        request_path(id), auth_params, model
-      )
-      responders.update.new(response.body, response.code)
+      result(:update, model, id)
     end
 
     def destroy(id)
-      response = requestors.destroy.new.fetch(
-        request_path(id), auth_params
-      )
-      responders.destroy.new(response.body, response.code)
+      result(:destroy, nil, id)
     end
 
     protected
 
-    def requestors
-      @requestors ||= Requests.new
-    end
-
-    def responders
-      @responders ||= Responses.new
+    def result(name, model, id = nil)
+      response_class = responses.public_send(name)
+      response_class.new(fetch_response(name, model, id))
     end
 
-    def update_params(model)
-      model.to_json
+    def fetch_response(name, model, id = nil)
+      path = pather.path(id)
+      request = requests.public_send(name)
+      serializer = serializers.public_send(name)
+      params = serializer.serialize(model)
+      fetch(path, request, params)
     end
 
-    def request_path(id = nil)
-      pather.path(id)
+    def fetch(path, request, params)
+      request.fetch(path, auth_params, params)
     end
 
     def auth_params

data/lib/json_client/base_requests/create.rb

@@ -3,20 +3,14 @@ require_relative 'request'
 module JsonClient
   module BaseRequests
     class Create < Request
-      def fetch(url, auth_params, model)
+      def fetch(url, auth_params, params)
         client.post(
           url,
-          auth_params.merge(create_params(model)).to_json,
+          auth_params.merge(params).to_json,
           content_type: :json,
           accept: :json
         )
       end
-
-      private
-
-      def create_params(model)
-        model.to_h
-      end
     end
   end
 end

data/lib/json_client/base_requests/destroy.rb

@@ -3,7 +3,7 @@ require_relative 'request'
 module JsonClient
   module BaseRequests
     class Destroy < Request
-      def fetch(url, auth_params)
+      def fetch(url, auth_params, params)
         client.delete(
           url, params: auth_params
         )

data/lib/json_client/base_requests/index.rb

@@ -3,7 +3,7 @@ require_relative 'request'
 module JsonClient
   module BaseRequests
     class Index < Request
-      def fetch(url, auth_params)
+      def fetch(url, auth_params, params = nil)
         client.get url, params: auth_params
       end
     end

data/lib/json_client/base_requests/show.rb

@@ -3,7 +3,7 @@ require_relative 'request'
 module JsonClient
   module BaseRequests
     class Show < Request
-      def fetch(url, auth_params)
+      def fetch(url, auth_params, params)
         client.get url, params: auth_params
       end
     end

data/lib/json_client/base_requests/update.rb

@@ -3,20 +3,14 @@ require_relative 'request'
 module JsonClient
   module BaseRequests
     class Update < Request
-      def fetch(url, auth_params, model)
+      def fetch(url, auth_params, params)
         client.put(
           url,
-          auth_params.merge(update_params(model)).to_json,
+          auth_params.merge(params).to_json,
           content_type: :json,
           accept: :json
         )
       end
-
-      protected
-
-      def update_params(model)
-        model.to_h
-      end
     end
   end
 end

data/lib/json_client/base_responses/create.rb

@@ -3,9 +3,6 @@ require_relative 'response'
 module JsonClient
   module BaseResponses
     class Create < Response
-      def initialize(body, code)
-        super
-      end
     end
   end
 end

data/lib/json_client/base_responses/destroy.rb

@@ -3,9 +3,6 @@ require_relative 'response'
 module JsonClient
   module BaseResponses
     class Destroy < Response
-      def initialize(body, code)
-        super
-      end
     end
   end
 end

data/lib/json_client/base_responses/index.rb

@@ -3,9 +3,6 @@ require_relative 'response'
 module JsonClient
   module BaseResponses
     class Index < Response
-      def initialize(body, code)
-        super
-      end
     end
   end
 end

data/lib/json_client/base_responses/response.rb

@@ -1,19 +1,18 @@
 module JsonClient
   module BaseResponses
     class Response
-      attr_reader :body, :code
+      attr_reader :raw_response
 
-      def initialize(body, code)
-        @body = body
-        @code = code
+      def initialize(raw_response)
+        @raw_response = raw_response
       end
 
-      def json
-        parse_json
+      def method_missing(name, *args)
+        raw_response.public_send(name, *args)
       end
 
-      def success?
-        code >= 200 && code < 300
+      def json
+        parse_json
       end
 
       protected

data/lib/json_client/base_responses/show.rb

@@ -3,9 +3,6 @@ require_relative 'response'
 module JsonClient
   module BaseResponses
     class Show < Response
-      def initialize(body, code)
-        super
-      end
     end
   end
 end

data/lib/json_client/base_responses/update.rb

@@ -3,9 +3,6 @@ require_relative 'response'
 module JsonClient
   module BaseResponses
     class Update < Response
-      def initialize(body, code)
-        super
-      end
     end
   end
 end

data/lib/json_client/base_serializer.rb

@@ -0,0 +1,12 @@
+
+module JsonClient
+  class BaseSerializer
+    def serialize(model)
+      if model.nil?
+        {}
+      else
+        model.to_h
+      end
+    end
+  end
+end

data/lib/json_client/dsl.rb

@@ -0,0 +1,49 @@
+require 'json_client/dsl/serializers_collector'
+require 'json_client/dsl/requests_collector'
+require 'json_client/dsl/on_use_collector'
+
+module JsonClient
+  module DSL
+    def serializers_collector
+      @serializers_collector ||= SerializersCollector.new
+    end
+
+    def serializers
+      collector = serializers_collector
+
+      yield collector
+
+      define_method :serializers do
+        collector
+      end
+    end
+
+    def requests_collector
+      @requests_collector ||= RequestsCollector.new
+    end
+
+    def requests
+      collector = requests_collector
+
+      yield collector
+
+      define_method :requests do
+        collector
+      end
+    end
+
+    def responses_collector
+      @responses_collector ||= OnUseCollector.new
+    end
+
+    def responses
+      collector = responses_collector
+
+      yield collector
+
+      define_method :responses do
+        collector
+      end
+    end
+  end
+end

data/lib/json_client/dsl/collector.rb

@@ -0,0 +1,13 @@
+require 'json_client/dsl/collector'
+
+module JsonClient
+  module DSL
+    class Collector
+      def method_missing(method_name, *collection)
+        define_singleton_method(method_name) do
+          collection.first
+        end
+      end
+    end
+  end
+end

data/lib/json_client/dsl/on_use_collector.rb

@@ -0,0 +1,32 @@
+module JsonClient
+  module DSL
+    class OnUseCollector
+      def on(*names, opts)
+        validate_opts!(opts)
+
+        thing = opts[:use]
+
+        Array(names).each do |name|
+          define_singleton_method(name) do
+            thing
+          end
+        end
+      end
+
+
+      protected
+
+      def collector_name
+        'thing'
+      end
+
+      def use_not_defined_message
+        "use: `#{collector_name}` must be defined"
+      end
+
+      def validate_opts!(opts)
+        fail use_not_defined_message if opts[:use].nil?
+      end
+    end
+  end
+end

data/lib/json_client/dsl/requests_collector.rb

@@ -0,0 +1,15 @@
+require 'json_client/dsl/on_use_collector'
+require 'json_client/dsl/collector'
+
+module JsonClient
+  module DSL
+    class RequestsCollector < OnUseCollector
+
+      protected
+
+      def collector_name
+        'request'
+      end
+    end
+  end
+end

data/lib/json_client/dsl/serializers_collector.rb

@@ -0,0 +1,15 @@
+require 'json_client/dsl/on_use_collector'
+require 'json_client/dsl/collector'
+
+module JsonClient
+  module DSL
+    class SerializersCollector < OnUseCollector
+
+      protected
+
+      def collector_name
+        'serializer'
+      end
+    end
+  end
+end

data/lib/json_client/empty_serializer.rb

@@ -0,0 +1,8 @@
+
+module JsonClient
+  class EmptySerializer
+    def serialize(model)
+      {}
+    end
+  end
+end

data/lib/json_client/resource_handler.rb

@@ -0,0 +1,9 @@
+require 'rest_client'
+require 'json_client/responses'
+require 'json_client/requests'
+
+module JsonClient
+  class ResourceHandler
+
+  end
+end

data/lib/json_client/version.rb

@@ -1,3 +1,3 @@
 module JsonClient
-  VERSION = "0.0.2"
+  VERSION = "0.1.2"
 end

data/spec/json_client/base_responses/response_spec.rb

@@ -18,14 +18,20 @@ describe JsonClient::BaseResponses::Response do
     %q<{ "hello" : "world" }>
   end
 
+  let(:response) do
+    Object.new.tap do |r|
+      def r.code; 200; end
+      def r.body; %q<{ "hello" : "world" }>; end
+    end
+  end
+
   let(:json) do
     JSON.parse(body)
   end
 
   subject do
     described_class.new(
-      body,
-      code
+      response
     )
   end
 

data/spec/json_client/dsl/collector_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rspec/collection_matchers'
+require 'json_client'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+describe JsonClient::DSL::Collector do
+  let(:collected) do
+    'hello world'
+  end
+
+  subject { described_class.new }
+
+  describe '::method_missing' do
+    it 'defines the method and returns the first argument' do
+      subject.index collected
+
+      expect(subject.index).to eq 'hello world'
+    end
+  end
+end

data/spec/json_client/dsl/serializers_collector_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'rspec/collection_matchers'
+require 'json_client'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+describe JsonClient::DSL::SerializersCollector do
+  let(:collected) do
+    'hello world'
+  end
+
+  subject { described_class.new }
+
+  describe '::method_missing' do
+    it 'defines the method and returns the first argument' do
+      subject.on :a, :b, use: 'hello'
+
+      expect(subject.a).to eq 'hello'
+      expect(subject.b).to eq 'hello'
+    end
+  end
+end

data/spec/json_client/dsl_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'rspec/collection_matchers'
+require 'json_client'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+describe JsonClient::DSL do
+  let(:example_class) do
+    class A
+      extend JsonClient::DSL
+
+      requests do |r|
+        r.on :index, use: 'abc'
+        r.on :delete, use: 'xyz'
+      end
+
+      serializers do |s|
+        s.on :index, :show, :read, use: 'hello'
+        s.on :delete, use: 'world'
+      end
+
+      responses do |r|
+        r.on :index, use: '0'
+        r.on :show, use: '1'
+      end
+    end
+
+    # return the class
+    A
+  end
+
+  let(:serializers) do
+    example_class.new.serializers
+  end
+
+  let(:requests) do
+    example_class.new.requests
+  end
+
+  let(:responses) do
+    example_class.new.responses
+  end
+
+
+  describe '#serializers' do
+    it 'adds a way of dynamically adding serializers' do
+
+      expect(serializers.index).to eq 'hello'
+      expect(serializers.show).to eq 'hello'
+      expect(serializers.read).to eq 'hello'
+
+      expect(serializers.delete).to eq 'world'
+    end
+  end
+
+  describe '#responses' do
+    it 'adds a way of dynamically adding responses' do
+      expect(responses.index).to eq '0'
+      expect(responses.show).to eq '1'
+    end
+  end
+
+  describe '#requests' do
+    it 'adds a way of dynamically adding requests' do
+      expect(requests.index).to eq 'abc'
+      expect(requests.delete).to eq 'xyz'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.2
 platform: ruby
 authors:
 - johnmcconnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: attr_init
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +164,16 @@ files:
 - lib/json_client/base_responses/response.rb
 - lib/json_client/base_responses/show.rb
 - lib/json_client/base_responses/update.rb
+- lib/json_client/base_serializer.rb
+- lib/json_client/dsl.rb
+- lib/json_client/dsl/collector.rb
+- lib/json_client/dsl/on_use_collector.rb
+- lib/json_client/dsl/requests_collector.rb
+- lib/json_client/dsl/serializers_collector.rb
+- lib/json_client/empty_serializer.rb
 - lib/json_client/pather.rb
 - lib/json_client/requests.rb
+- lib/json_client/resource_handler.rb
 - lib/json_client/responses.rb
 - lib/json_client/version.rb
 - spec/fixtures/vcr_cassettes/all_success.yml
@@ -163,6 +185,9 @@ files:
 - spec/json_client/base_requests/request_spec.rb
 - spec/json_client/base_responses/response_spec.rb
 - spec/json_client/base_spec.rb
+- spec/json_client/dsl/collector_spec.rb
+- spec/json_client/dsl/serializers_collector_spec.rb
+- spec/json_client/dsl_spec.rb
 - spec/json_client/pather_spec.rb
 - spec/json_client/requests_spec.rb
 - spec/json_client/responses_spec.rb
@@ -202,6 +227,9 @@ test_files:
 - spec/json_client/base_requests/request_spec.rb
 - spec/json_client/base_responses/response_spec.rb
 - spec/json_client/base_spec.rb
+- spec/json_client/dsl/collector_spec.rb
+- spec/json_client/dsl/serializers_collector_spec.rb
+- spec/json_client/dsl_spec.rb
 - spec/json_client/pather_spec.rb
 - spec/json_client/requests_spec.rb
 - spec/json_client/responses_spec.rb