json_client 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd8fc37e70c92b79134039e9a0f3985b57ed451
-  data.tar.gz: 7a961eee575d754cc11879d6ad4dc542315a1019
+  metadata.gz: c939e92cf7be2e4d0e73ccc904c392b50d85f779
+  data.tar.gz: 96ebf0b99e4bf9c39ad8cfc5909945b08191a3a8
 SHA512:
-  metadata.gz: 7479e78af37b510c906d366d0540595cfe70d678c513d7808f78b68aaccdb0e009b4852fa2d811e2d8aeb56ef0679706ed2e40ae65ca9f934717907a130e9370
-  data.tar.gz: 41110ba1b172a29560d7a20e3bf415f23b37a4faa47726ce1f280ccd38aa76810f5a5d0b49d3f362ba2529c9e860d50730cc9480ae26a7cea86a8e0953a2aa28
+  metadata.gz: c53e5204fe5d49fd3a0c065d52777f0783dcebc7806ecda9f9650fcb1d1ba0e0cbb230883997c65cd404e86a5ab8e6dd8b2eb2f581dd4154491094c43bd4aed2
+  data.tar.gz: ccb9e2796015af82fe7cf32bed3cd06b0abfcf24b8e86bc9e139c72672347af2ca32c8d2d685f43099c7792cfcceb56074d6ea480a57931e9695333d0ed1446a

data/README.md

@@ -27,10 +27,6 @@ Or install it yourself as:
 
 ## Usage
 
-I've avoided using a DSL in favor of good engineering principals. I am
-hoping the DSL will come after.
-
-
 ```
 require 'json_client'
 
@@ -41,40 +37,45 @@ class Client < JsonClient::Base
 
   def pather
     @pather ||=
-      JsonClient::Pather.new(
+      JsonClient::UriBuilder.new(
         'https://example.host.com',
         'api/v1',
-        'objects'
+        'objects',
+        '80'
       )
   end
 end
 
 config = {
-  api_key: 'api_key',
-  api_password: 'api_password'
+  client_id: '1',
+  secret_key: 'dummmy_key',
+  host: '127.0.0.1',
+  port: '3000'
 }
 
 client = Client.new(config)
 
-# GET https://example.host.com/api/v1/objects?api_key=api_key&api_password=api_password
+# GET http://example.host.com:80/api/v2/objects/2
+# Headers:
+# Content-Type: application/json
+# Accept: application/json
+# Authorization: APIAuth 1:oh3o3h00312h320u530s=
 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
+# GET http://example.host.com:80/api/v2/objects
+# Headers:
+# Content-Type: application/json
+# Accept: application/json
+# Authorization: APIAuth 1:oh3o3h00312h320u530s=
 client.show(2).json
  => { 'object_json' : 'is_parsed_here' }
 ```
 
 ## Best Guide
 
-The best guide is [this
-test](https://github.com/johnmcconnell/json_client/blob/master/spec/json_client/base_spec.rb).
-Sorry non rspec people
+Use [this test](https://github.com/johnmcconnell/json_client/blob/master/spec/json_client/base_spec.rb)
+as a guide.
 
 ## Contributing
-
-1. Fork it ( https://github.com/johnmcconnell/json_client/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Contributions Welcome

data/Rakefile

@@ -1,7 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 task default: :spec
 RSpec::Core::RakeTask.new(:spec)
-
-

data/json_client.gemspec

@@ -4,28 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "json_client"
+  spec.name          = 'json_client'
   spec.version       = JsonClient::VERSION
-  spec.authors       = ["johnmcconnell"]
-  spec.email         = ["johnnyillinois@gmail.com"]
-  spec.summary       = %q{crud json client to make creating services easy'}
-  spec.description   = %q{crud json client to make creating services easy'}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['johnmcconnell']
+  spec.email         = ['johnnyillinois@gmail.com']
+  spec.summary       = "crud json client to make creating services easy'"
+  spec.description   = "crud json client to make creating services easy'"
+  spec.homepage      = ''
+  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.require_paths = ['lib']
 
-  spec.add_dependency 'rest-client', '~> 1.7.2'
-  spec.add_dependency 'attr_init', '~> 0.0.4'
+  spec.add_dependency 'attr_init'
+  spec.add_dependency 'api-auth'
 
-  spec.add_development_dependency "simplecov", "~> 0.8.0"
-  spec.add_development_dependency "coveralls", "~> 0.7.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-collection_matchers"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
 end

data/lib/json_client.rb

@@ -1,10 +1,22 @@
-require "json_client/version"
-require "json_client/base"
-require "json_client/pather"
-require "json_client/dsl"
+require 'json_client/version'
+require 'json_client/base'
+require 'json_client/model_serializer'
+require 'json_client/uri_builder'
+
+require 'digest'
 
 module JsonClient
-  def self.new(pather, config)
-    Base.new(pather, config)
+  class << self
+    def new(uri_builder, config)
+      Base.new(uri_builder, config)
+    end
+
+    def md5_base64_digest(string)
+      Digest::MD5.base64digest(string)
+    end
+
+    def b64_encode(string)
+      Base64.strict_encode64(string)
+    end
   end
 end

data/lib/json_client/base.rb

@@ -1,52 +1,43 @@
-require 'rest_client'
-
-require 'json_client/dsl'
-require 'json_client/responses'
 require 'json_client/requests'
-require 'json_client/model_serializer'
+require 'json_client/response'
 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'
+require 'json_client/dsl'
+require 'pry'
 
 module JsonClient
   class Base
     extend DSL
-    attr_reader :api_key, :api_password, :pather
+    attr_reader :secret_key, :client_id, :uri_builder
+
+    J = ::JsonClient
+    RS = J::Requests
 
     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
+      r.on :index, use: RS::Index
+      r.on :show, use: RS::Show
+      r.on :create, use: RS::Create
+      r.on :update, use: RS::Update
+      r.on :destroy, use: RS::Destroy
     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
+      r.on :index, use: J::Response
+      r.on :show, use: J::Response
+      r.on :create, use: J::Response
+      r.on :update, use: J::Response
+      r.on :destroy, use: J::Response
     end
 
     serializers do |s|
-      s.on :create, :update, :destroy, use: BaseSerializer.new
-      s.on :index, :show, use: EmptySerializer.new
+      s.on :create, :update, :destroy, use: J::BaseSerializer.new
+      s.on :index, :show, use: J::EmptySerializer.new
     end
 
-    def initialize(pather, config)
-      @api_key = config[:api_key]
-      @api_password = config[:api_password]
-      @pather = pather
+    def initialize(uri_builder, config)
+      @client_id = config[:client_id]
+      @secret_key = config[:secret_key]
+      @uri_builder = uri_builder
       validate_variables
     end
 
@@ -72,36 +63,46 @@ module JsonClient
 
     protected
 
-    def result(name, model, id = nil)
-      response_class = responses.public_send(name)
-      response_class.new(fetch_response(name, model, id))
+    def result(protocol, model, id = nil)
+      responder = responders.for(protocol)
+
+      ## Fetch the response for protocol
+      response = fetch_response(protocol, model, id)
+
+      ## Create new response
+      responder.new(response)
     end
 
-    def fetch_response(name, model, id = nil)
-      path = pather.path(id)
-      request = requests.public_send(name)
-      serializer = serializers.public_send(name)
+    def build_request(protocol, model, id = nil)
+      ## Get URL path
+      uri = uri_builder.uri(id)
+      requester = requestors.for(protocol)
+
+      ## Find serializer for model
+      serializer = serializers.for(protocol)
       params = serializer.serialize(model)
-      fetch(path, request, params)
+
+      ## Build the request object
+      requester.new(uri, auth_params, params)
     end
 
-    def fetch(path, request, params)
-      request.fetch(path, auth_params, params)
+    def fetch_response(protocol, model, id = nil)
+      build_request(protocol, model, id).fetch
     end
 
     def auth_params
       {
-        api_key: api_key,
-        api_password: api_password
+        client_id: client_id,
+        secret_key: secret_key
       }
     end
 
     private
 
     def validate_variables
-      fail 'api_key must be set' if api_key.nil?
-      fail 'api_password must be set' if api_password.nil?
-      fail 'pather must be set' if pather.nil?
+      %w(uri_builder client_id secret_key).each do |name|
+        fail "#{name} must be set" if (send name).nil?
+      end
     end
   end
 end

data/lib/json_client/base_serializer.rb

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

data/lib/json_client/create.rb

@@ -0,0 +1,9 @@
+module JsonClient
+  module Create
+    class Request < ::JsonClient::RequestWithBody
+      def fetch
+        fetch_method(:post)
+      end
+    end
+  end
+end

data/lib/json_client/destroy.rb

@@ -0,0 +1,11 @@
+module JsonClient
+  module Destroy
+    class Request < ::JsonClient::Request
+      def fetch
+        client.delete(
+          url, params: auth_params
+        )
+      end
+    end
+  end
+end

data/lib/json_client/dsl.rb

@@ -27,7 +27,7 @@ module JsonClient
 
       yield collector
 
-      define_method :requests do
+      define_method :requestors do
         collector
       end
     end
@@ -41,7 +41,7 @@ module JsonClient
 
       yield collector
 
-      define_method :responses do
+      define_method :responders do
         collector
       end
     end

data/lib/json_client/dsl/on_use_collector.rb

@@ -13,6 +13,9 @@ module JsonClient
         end
       end
 
+      def for(name)
+        public_send name
+      end
 
       protected
 

data/lib/json_client/dsl/requests_collector.rb

@@ -4,7 +4,6 @@ require 'json_client/dsl/collector'
 module JsonClient
   module DSL
     class RequestsCollector < OnUseCollector
-
       protected
 
       def collector_name

data/lib/json_client/dsl/serializers_collector.rb

@@ -4,7 +4,6 @@ require 'json_client/dsl/collector'
 module JsonClient
   module DSL
     class SerializersCollector < OnUseCollector
-
       protected
 
       def collector_name

data/lib/json_client/empty_serializer.rb

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

data/lib/json_client/index.rb

@@ -0,0 +1,9 @@
+module JsonClient
+  module Index
+    class Request < ::JsonClient::Request
+      def fetch
+        client.get url, params: auth_params
+      end
+    end
+  end
+end

data/lib/json_client/model_serializer.rb

@@ -5,6 +5,10 @@ module JsonClient
     reader_struct :model_name
 
     def serialize(model)
+      to_h(model).to_json
+    end
+
+    def to_h(model)
       { model_name => model.to_h }
     end
   end

data/lib/json_client/request.rb

@@ -0,0 +1,48 @@
+require 'api_auth'
+
+module JsonClient
+  class Request
+    attr_reader :uri, :auth_params, :params
+
+    def initialize(uri, auth_params, params)
+      @uri = uri
+      @auth_params = auth_params
+      @params = params
+    end
+
+    def sign!(request)
+      ApiAuth.sign!(
+        request,
+        auth_params[:client_id],
+        auth_params[:secret_key]
+      )
+    end
+
+    protected
+
+    def execute!(request)
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(
+          sign!(request)
+        )
+      end
+    end
+
+    def client
+      Net::HTTP
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }
+    end
+
+    def validate_variables
+      %w(url auth_params).each do |name|
+        fail "#{name} must be set" if (send name).nil?
+      end
+    end
+  end
+end