rsbe-client 0.5.0

data/lib/rsbe/client/connection.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+module Rsbe
+  module Client
+    class Connection
+      extend Forwardable
+      def_delegators :@conn, :get, :put, :post, :delete, :patch
+
+      def initialize
+        @user     = ENV['RSBE_USER']     || 'foo'
+        @password = ENV['RSBE_PASSWORD'] || 'bar'
+        @url      = ENV['RSBE_URL']      || 'http://localhost:3000'
+        @conn     = Faraday.new(url: @url) do |faraday|
+          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+        @conn.basic_auth(@user, @password)
+      end
+
+      def same_origin?(url)
+        (url =~ /\A#{@url}/) ? true : false
+      end  
+    end
+  end
+end

data/lib/rsbe/client/method_not_implemented_error.rb

@@ -0,0 +1,6 @@
+module Rsbe
+  module Client
+    class MethodNotImplementedError < RuntimeError
+    end
+  end
+end

data/lib/rsbe/client/not_found_error.rb

@@ -0,0 +1,6 @@
+module Rsbe
+  module Client
+    class RecordNotFound < RuntimeError
+    end
+  end
+end

data/lib/rsbe/client/partner.rb

@@ -0,0 +1,82 @@
+require 'active_support'
+
+module Rsbe
+  module Client
+    # Class simplifies interaction with RSBE Partner resources
+    class Partner < Base
+      def self.base_path
+        super + '/partners'
+      end
+
+      # implementation objectives:
+      # - expose attributes via standard setter/getter methods
+      # - create getters for  all Read-Only  (RO) attributes
+      # - create setters only for Read/Write (RW) attributes
+      # - use hash for internal representation to simplify passing
+      #   data back and forth to back end app
+
+      def self.rw_attrs
+        [:id, :code, :name, :rel_path]
+      end
+
+      def self.ro_attrs
+        [:created_at, :updated_at, :lock_version]
+      end
+
+      def self.all_attrs
+        rw_attrs + ro_attrs
+      end
+
+      # define setter methods for RW attributes
+      rw_attrs.each { |m| define_method("#{m}=") {|v| @hash[m] = v} }
+
+      # define getter methods for ALL attributes
+      # all_attrs.each { |m| define_method("#{m}")  { @hash[m]} }
+      all_attrs.each do |m|
+        define_method("#{m}")  do
+          @hash[m] || begin
+                        # only fetch if Partner has a known id
+                        if @hash[:id]
+                          # TODO: CLEAN THIS UP
+                          # This works currently because when a 404 is
+                          # returned there is nothing in the response
+                          # hash that matches the resource attributes,
+                          # but relying on this behavior seems very
+                          # brittle. Additionally, for every attribute
+                          # queried, a GET operation is performed.
+                          # Should store the object lifecycle state,
+                          # e.g.,
+                          # - new, no ID, no matching resource in RSBE: don't query RSBE
+                          # - new, ID assigned, but not yet    in RSBE: don't query RSBE
+                          # - existing, partially populated,
+                          #   not fully updated with RSBE values:             query RSBE
+                          # - existing, fully populated with data from RSBE
+                          # - existing, local modifications, not persisted to RSBE
+                          #
+                          get
+                          update_hash_nils_from_response
+                        end
+                        @hash[m]
+                      end
+        end
+      end
+
+      def initialize(vals = {})
+        fail(ArgumentError, 'Constructor requires a Hash') unless vals.is_a?(Hash)
+        super()
+        @hash = {}
+        @response = nil
+
+        # initialize local hash with incoming values, restrict to RW attrs
+        self.class.rw_attrs.each { |x| @hash[x] = (vals[x] || vals[x.to_s]) }
+      end
+
+      def collections
+        fail 'Error getting collections' unless get_children('colls')
+        JSON.parse(@response.body).collect do |json_hash|
+          Rsbe::Client::Collection.new(json_hash)
+        end
+      end
+    end
+  end
+end

data/lib/rsbe/client/provider.rb

@@ -0,0 +1,47 @@
+require 'active_support'
+
+module Rsbe
+  module Client
+    class Provider < Base
+
+      def self.base_path
+        super + '/providers'
+      end
+
+      # implementation objectives:
+      # - expose attributes via standard setter/getter methods
+      # - create getters for  all Read-Only  (RO) attributes
+      # - create setters only for Read/Write (RW) attributes
+      # - use hash for internal representation to simplify passing
+      #   data back and forth to back end app
+
+      def self.rw_attrs
+        [:id, :name]
+      end
+
+      def self.ro_attrs
+        [:created_at, :updated_at, :lock_version]
+      end
+
+      def self.all_attrs
+        self.rw_attrs + self.ro_attrs
+      end
+
+      # define setter methods for RW attributes
+      self.rw_attrs.each  {|m| define_method("#{m}=") {|v| @hash[m] = v}}
+
+      # define getter methods for ALL attributes
+      self.all_attrs.each {|m| define_method("#{m}")  { @hash[m]}}
+
+      def initialize(vals = {})
+        raise ArgumentError.new("Constructor requires a Hash") unless vals.is_a?(Hash)
+        super()
+        @hash = {}
+        @response = nil
+
+        # initialize local hash with incoming values, restrict to RW attrs
+        self.class.rw_attrs.each { |x| @hash[x] = (vals[x] || vals[x.to_s]) }
+      end
+    end
+  end
+end

data/lib/rsbe/client/se.rb

@@ -0,0 +1,97 @@
+require 'active_support'
+
+module Rsbe
+  module Client
+    class Se < Base
+      def self.all
+        emsg = 'Method not supported. Access via Rsbe::Client::Partner#collections'
+        fail Rsbe::Client::MethodNotImplementedError, emsg
+      end
+
+      def self.base_path
+        super + '/ses'
+      end
+
+      def self.search(params = {})
+        string_keys = []
+        raise ArgumentError.new("Required params: #{search_required_keys}") if
+        params.empty?
+        required_params = search_required_keys
+        search_params = {params: params, required_params: required_params, scope: search_scope}
+        Search.search(search_params)
+      end
+
+      def self.search_required_keys
+        []
+      end
+
+      def self.search_scope
+        "ses"
+      end
+
+      private_class_method :search_required_keys, :search_scope
+
+      # implementation objectives:
+      # - expose attributes via standard setter/getter methods
+      # - create getters for  all Read-Only  (RO) attributes
+      # - create setters only for Read/Write (RW) attributes
+      # - use hash for internal representation to simplify passing
+      #   data back and forth to back end app
+
+      def self.rw_attrs
+        [:id, :coll_id, :digi_id, :do_type, :phase, :step, :status, :label, :notes]
+      end
+
+      def self.ro_attrs
+        [:created_at, :updated_at, :lock_version]
+      end
+
+      def self.all_attrs
+        self.rw_attrs + self.ro_attrs
+      end
+
+      # define setter methods for RW attributes
+      self.rw_attrs.each  {|m| define_method("#{m}=") {|v| @hash[m] = v}}
+
+      # define getter methods for ALL attributes
+      all_attrs.each do |m|
+        define_method("#{m}")  do
+          @hash[m] || begin
+                        # only fetch if object has a known id
+                        if @hash[:id]
+                          # TODO: CLEAN THIS UP
+                          # This works currently because when a 404 is
+                          # returned there is nothing in the response
+                          # hash that matches the resource attributes,
+                          # but relying on this behavior seems very
+                          # brittle. Additionally, for every attribute
+                          # queried, a GET operation is performed.
+                          # Should store the object lifecycle state,
+                          # e.g.,
+                          # - new, no ID, no matching resource in RSBE: don't query RSBE
+                          # - new, ID assigned, but not yet    in RSBE: don't query RSBE
+                          # - existing, partially populated,
+                          #   not fully updated with RSBE values:             query RSBE
+                          # - existing, fully populated with data from RSBE
+                          # - existing, local modifications, not persisted to RSBE
+                          #
+                          get
+                          update_hash_nils_from_response
+                        end
+                        @hash[m]
+                      end
+        end
+      end
+
+      def initialize(vals = {})
+        raise ArgumentError.new("Constructor requires a Hash") unless vals.is_a?(Hash)
+        super()
+        @hash = {}
+        @response = nil
+
+        # initialize local hash with incoming values, restrict to RW attrs
+        self.class.rw_attrs.each { |x| @hash[x] = (vals[x] || vals[x.to_s]) }
+      end
+    end
+  end
+end

data/lib/rsbe/client/search.rb

@@ -0,0 +1,80 @@
+module Rsbe
+  module Client
+    module Search
+      def self.search(hsh = {})
+        raise ArgumentError.new("These args must be present: #{hsh_valid_keys}") if hsh.empty?
+        @hsh = hsh
+        # check if search params are valid
+        is_valid?
+        @args = hsh[:params]
+        @required_keys = hsh[:required_params]
+        @scope = hsh[:scope]
+        # check search args sent
+        chk_search_args
+        # build query url
+        @search_url = query_search_url
+        query
+      end
+
+      def self.query_search_url
+        base_url = Rsbe::Client::Base.base_path
+        query_hsh = parameterize_params
+        search_url = "#{base_url}/#{search_url_fragment}?#{query_hsh}"
+      end
+
+      def self.query
+        conn = Rsbe::Client::Connection.new
+        @response = conn.get @search_url
+      end
+
+      def self.search_url_fragment
+        "search"
+      end
+
+      def self.parameterize_params
+        query_hsh = @args.merge({scope: @scope})
+        arr = []
+        query_hsh.each_pair { |q,v|
+          arr << "#{q}=#{v}"
+        }
+        arr.join("&")
+      end
+
+      def self.chk_search_args
+        string_keys?
+        incoming_keys = @args.keys.sort
+        compare_keys(incoming_keys,@required_keys)
+      end
+
+      def self.string_keys?
+        string_keys = []
+        @args.keys.each { |k|
+          string_keys << k unless k.is_a?(Symbol)
+        }
+        raise ArgumentError.new("Param key: #{string_keys} should be of type Symbol") if string_keys.size > 0
+      end
+      def self.compare_keys(incoming_keys, required_keys)
+        unless required_keys.empty?
+          compare_keys = incoming_keys - required_keys
+          raise ArgumentError.new("Required params: #{required_keys}") unless compare_keys.empty?
+        end
+      end
+
+      def self.is_valid?
+        case @hsh.class.to_s
+        when "Hash"
+          incoming_keys = @hsh.keys.sort
+          compare_keys(incoming_keys,hsh_valid_keys)
+        else
+          raise ArgumentError.new("Expecting hash as a arguments with the following arguments: #{hsh_valid_keys}")
+        end
+      end
+
+      def self.hsh_valid_keys
+        [:params, :required_params, :scope].sort
+      end
+
+      private_class_method :chk_search_args, :compare_keys, :hsh_valid_keys, :is_valid?, :query_search_url, :parameterize_params, :search_url_fragment, :query, :string_keys?
+    end
+  end
+end

data/lib/rsbe/client/search_results.rb

@@ -0,0 +1,41 @@
+module Rsbe
+  module Client
+    class SearchResults
+      def initialize(api_response)
+        @api_response = api_response
+        # init json
+        json
+      end
+
+      def success?
+        @api_response.status == 200
+      end
+
+      def num_found
+        response['numFound']
+      end
+
+      def results
+        @results ||= urls.collect {|u| Rsbe::Client.find(u)}
+      end
+
+      private
+
+      def response
+        @response ||= json['response']
+      end
+
+      def json
+        @json ||= JSON.parse(@api_response.body)
+      end
+
+      def docs
+        @docs ||= response['docs']
+      end
+
+      def urls
+        @urls ||= docs.collect {|d| d['url']}
+      end
+    end
+  end
+end

data/lib/rsbe/client/unrecognized_resource_error.rb

@@ -0,0 +1,6 @@
+module Rsbe
+  module Client
+    class UnrecognizedResourceError < ArgumentError
+    end
+  end
+end

data/lib/rsbe/client/version.rb

@@ -0,0 +1,5 @@
+module Rsbe
+  module Client
+    VERSION = "0.5.0"
+  end
+end

data/lib/rsbe/client/wrong_origin_error.rb

@@ -0,0 +1,6 @@
+module Rsbe
+  module Client
+    class WrongOriginError < ArgumentError
+    end
+  end
+end

data/rsbe-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rsbe/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rsbe-client"
+  spec.version       = Rsbe::Client::VERSION
+  spec.authors       = ["jgpawletko"]
+  spec.email         = ["jgpawletko@gmail.com"]
+  spec.summary       = %q{Client library for interacting with rsbe API.}
+  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.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec-its", "~> 1.0.1"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.18.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+
+  spec.add_dependency "faraday", "~> 0.9.0"
+  spec.add_dependency "activesupport", "~> 4.1.6"
+end