ddr-aux-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9c3cc6c1e5f15ab0e067460e227071a3493f11
-  data.tar.gz: ecf92af2bfd5010f4bd33295c661996f3732f7a7
+  metadata.gz: 859ccede341d46abeeb166e9e69de02cb36d93ef
+  data.tar.gz: a45bc63f297283af6d749eb3c39c882fd6095e60
 SHA512:
-  metadata.gz: f8fb113dd55fbb8fa53471e6fa006dc57424e9700e08319a5a6aaa8ab3377bcc126545d33014df45c349c946f6ea1209b07c1651339105ae1c0ec8c974eff036
-  data.tar.gz: b1d6a84bffb0d269b82ba086aac61e1d33deecd0b0e3c38d366d6077cf067175703ed2d6dbf4518959a2735c7e7997702426f4eb602bad2e5f1db84f421bf3fb
+  metadata.gz: 4ce07a5dea2a6b5a05c1d346bd0793b76af10283217cf8d918f840b568207f47459ca07df32c8332d4cebb5ac57fe88472b2184db770f3e95caef2088c53ff17
+  data.tar.gz: 9eb774411533890f521e79b5db0694ed2146a76f1eaff528e0f681ddf18cef540a7300846d418232cc9cd7e216649c16b47c7b22c978487b2371d76e59d7b862

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.2
   - 2.1.5
 before_install: gem install bundler -v 1.10.2
 

data/README.md

@@ -20,7 +20,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See [API](https://github.com/duke-libraries/ddr-aux-client/wiki/API).
+
+Configure the ddr-aux API URL via the `DDR_AUX_API_URL` environment variable, or by using the attribute setter:
+
+```ruby
+DdrAux::Client.api_url = "http://localhost:3000/api"
+```
 
 ## Development
 

data/ddr-aux-client.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "hashie", "~> 3.4"
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/ddr_aux/client.rb

@@ -1,16 +1,25 @@
 require "ddr_aux/client/version"
-require "ddr_aux/client/connection"
-require "ddr_aux/client/api"
 
 module DdrAux
   module Client
-    extend Api
+    autoload :AdminSet,   "ddr_aux/client/admin_set"
+    autoload :Api,        "ddr_aux/client/api"
+    autoload :Connection, "ddr_aux/client/connection"
+    autoload :License,    "ddr_aux/client/license"
+    autoload :Model,      "ddr_aux/client/model"
+    autoload :Request,    "ddr_aux/client/request"
+    autoload :Response,   "ddr_aux/client/response"
 
     class << self
       attr_accessor :api_url
+
+      def uri
+        URI(api_url)
+      end
     end
 
     self.api_url = ENV["DDR_AUX_API_URL"]
 
+    extend Api
   end
 end

data/lib/ddr_aux/client/admin_set.rb

@@ -0,0 +1,9 @@
+module DdrAux::Client
+  class AdminSet < Model
+
+    self.path = "/admin_sets"
+
+    coerce_timestamps!
+
+  end
+end

data/lib/ddr_aux/client/api.rb

@@ -1,31 +1,29 @@
-require "uri"
-require_relative "api/model"
-require_relative "api/license"
-require_relative "api/admin_set"
-
 module DdrAux::Client
   module Api
 
     MODELS = {
-      license: License,
-      admin_set: AdminSet,
+      license: "License",
+      admin_set: "AdminSet",
     }.freeze
 
-    MODELS.each do |key, klass|
+    MODELS.each do |key, class_name|
       # get_license(id) => License.get(id)
       define_method "get_#{key}" do |id|
+        klass = const_get(class_name, false)
         klass.get(id)
       end
 
       # get_licenses => License.list
       # licenses => License.list
       define_method "get_#{key}s" do
+        klass = const_get(class_name, false)
         klass.list
       end
       alias_method "#{key}s", "get_#{key}s"
 
       # find_license(**args) => License.find(**args)
       define_method "find_#{key}" do |args|
+        klass = const_get(class_name, false)
         klass.find **args
       end
 

data/lib/ddr_aux/client/connection.rb

@@ -1,6 +1,5 @@
-require 'net/http'
-require 'json'
-require 'delegate'
+require "net/http"
+require "delegate"
 
 module DdrAux::Client
   class Connection < SimpleDelegator
@@ -10,29 +9,18 @@ module DdrAux::Client
     end
 
     def initialize
-      conn = Net::HTTP.new(uri.host, uri.port)
+      uri = DdrAux::Client.uri
+      super Net::HTTP.new(uri.host, uri.port)
       if uri.scheme == "https"
-        conn.use_ssl = true
-        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        self.use_ssl = true
+        self.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
-      super conn
     end
 
     def get_response(relative_path)
-      path = uri.path + relative_path
-      res = get(path, request_headers)
-      res.value # raises exception if not 2XX response code
-      JSON.parse(res.body)
-    end
-
-    private
-
-    def uri
-      URI(DdrAux::Client.api_url)
-    end
-
-    def request_headers
-      {"Accept"=>"application/json"}
+      warn "[DEPRECATION] `get_response` is deprecated and will be removed from ddr-aux-client 2.0." \
+           " Use `DdrAux::Client::Request.get_response` instead."
+      Request.get_response(relative_path)
     end
 
   end

data/lib/ddr_aux/client/license.rb

@@ -0,0 +1,9 @@
+module DdrAux::Client
+  class License < Model
+
+    self.path = "/licenses"
+
+    coerce_timestamps!
+
+  end
+end

data/lib/ddr_aux/client/model.rb

@@ -0,0 +1,49 @@
+require "uri"
+require "hashie"
+require "delegate"
+require "time"
+
+module DdrAux::Client
+  # @abstract
+  class Model < Hashie::Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::IndifferentAccess
+    include Hashie::Extensions::MethodReader
+    include Hashie::Extensions::Coercion
+
+    DEFAULT_TIMESTAMPS = [:created_at, :updated_at].freeze
+
+    class << self
+
+      attr_accessor :path
+      private :path=
+
+      def coerce_timestamps!(*keys)
+        if keys.empty?
+          keys = DEFAULT_TIMESTAMPS
+        end
+        coerce_keys *keys, ->(v) { ::Time.parse(v) }
+      end
+
+      def get(id)
+        request_path = [path, id].join("/")
+        response = Request.get_response(request_path)
+        new response.to_h
+      end
+
+      def list
+        response = Request.get_response(path)
+        response.map { |record| new(record) }
+      end
+      alias_method :all, :list
+
+      def find(**args)
+        request_path = "#{path}/find?%s" % URI.encode_www_form(args)
+        response = Request.get_response(request_path)
+        new response.to_h
+      end
+      alias_method :where, :find
+    end
+
+  end
+end

data/lib/ddr_aux/client/request.rb

@@ -0,0 +1,28 @@
+module DdrAux::Client
+  class Request
+
+    attr_reader :connection, :path
+
+    def self.get_response(path)
+      new(path).get_response
+    end
+
+    def initialize(path)
+      @path = path
+      @connection = Connection.new
+    end
+
+    def get_response
+      request_path = DdrAux::Client.uri.path + path
+      http_res = connection.get(request_path, request_headers)
+      Response.new http_res
+    end
+
+    private
+
+    def request_headers
+      {"Accept"=>"application/json"}
+    end
+
+  end
+end

data/lib/ddr_aux/client/response.rb

@@ -0,0 +1,13 @@
+require "json"
+require "delegate"
+
+module DdrAux::Client
+  class Response < SimpleDelegator
+
+    def initialize(response)
+      response.value # raises exception if not 2XX response code
+      super JSON.parse(response.body)
+    end
+
+  end
+end

data/lib/ddr_aux/client/version.rb

@@ -1,5 +1,5 @@
 module DdrAux
   module Client
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ddr-aux-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,11 +98,13 @@ files:
 - bin/setup
 - ddr-aux-client.gemspec
 - lib/ddr_aux/client.rb
+- lib/ddr_aux/client/admin_set.rb
 - lib/ddr_aux/client/api.rb
-- lib/ddr_aux/client/api/admin_set.rb
-- lib/ddr_aux/client/api/license.rb
-- lib/ddr_aux/client/api/model.rb
 - lib/ddr_aux/client/connection.rb
+- lib/ddr_aux/client/license.rb
+- lib/ddr_aux/client/model.rb
+- lib/ddr_aux/client/request.rb
+- lib/ddr_aux/client/response.rb
 - lib/ddr_aux/client/version.rb
 homepage: https://github.com/duke-libraries/ddr-aux-client
 licenses: []

data/lib/ddr_aux/client/api/admin_set.rb

@@ -1,9 +0,0 @@
-module DdrAux::Client
-  module Api
-    class AdminSet < Model
-
-      self.path = "/admin_sets"
-
-    end
-  end
-end

data/lib/ddr_aux/client/api/license.rb

@@ -1,9 +0,0 @@
-module DdrAux::Client
-  module Api
-    class License < Model
-
-      self.path = "/licenses"
-
-    end
-  end
-end

data/lib/ddr_aux/client/api/model.rb

@@ -1,26 +0,0 @@
-require "uri"
-
-module DdrAux::Client
-  module Api
-    class Model
-
-      class << self
-        attr_accessor :path
-
-        def get(id)
-          Connection.call [path, id].join("/")
-        end
-
-        def list
-          Connection.call path
-        end
-        alias_method :all, :list
-
-        def find(**args)
-          Connection.call "#{path}/find?%s" % URI.encode_www_form(args)
-        end
-      end
-
-    end
-  end
-end