apiphobic-resource 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aad272bf8a8f332e0fedc698fede4e0aa85808d7c416bd6475e0ac70795a1039
+  data.tar.gz: b9aedf6d02180664731f177c9adf2b16a42229523e45d002480623e4f6d4724f
+SHA512:
+  metadata.gz: 19fac65555022fe9c108a278c5687056233d7a8a4715486bbd14b7fe2ad91f99fcc2b5644eb62714072686328baf2db2ce878c691aa87c7068447dae2cb33000
+  data.tar.gz: 03b6fe9c87cbbbce13dcdd63b0a0500a05f2effe5213b33b7b0524b959c3d7010689bc6c8f625db6527dc2d426023840ea519ddfb35c48831550c0fe312d58c3

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2016 The Kompanee, Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Resource
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/resource`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resource'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resource
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jfelchner/resource.

data/lib/apiphobic-resource.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'apiphobic/resource/version'

data/lib/apiphobic/parameters/filter.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module  Apiphobic
+module  Parameters
+class   Filter
+  FLOAT           = /\A[\-+]?[_\d]+\.[_\d]+\z/
+  INTEGER         = /\A[\-+]?[_\d]+\z/
+  ISO8601         = /\d{4}\-\d{2}\-\d{2}T\d{2}\:\d{2}\:\d{2}(?:[+\-]\d{2}\:\d{2}|Z)/
+  NUMERICAL       = /[\-+]?[_\d]+(?:\.\d+)?/
+
+  DATE_RANGE      = /\A(#{ISO8601})\.\.\.?(#{ISO8601})\z/
+  NUMERICAL_RANGE = /\A(#{NUMERICAL})\.\.\.?(#{NUMERICAL}|Infinity)\z/
+
+  attr_accessor :raw_parameters
+
+  def initialize(raw_parameters)
+    self.raw_parameters = raw_parameters || {}
+  end
+
+  def present?
+    compacted_parameters.any?
+  end
+
+  def each_with_object(memoized)
+    compacted_parameters.each do |name, value|
+      yield [name, format_value(value)], memoized
+    end
+
+    memoized
+  end
+
+  private
+
+  def compacted_parameters
+    @compacted_parameters ||= raw_parameters.reject do |name, value|
+      name == 'query' ||
+      value == '' ||
+      value.nil?
+    end
+  end
+
+  # rubocop:disable Lint/AssignmentInCondition, Metrics/AbcSize,
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def format_value(value)
+    return value unless value.is_a?(::String)
+
+    if range_points  = value.match(DATE_RANGE)
+      exclusive      = value.include?('...')
+      starting_point = ::Time.iso8601(range_points[1])
+      ending_point   = ::Time.iso8601(range_points[2])
+
+      ::Range.new(starting_point, ending_point, exclusive)
+    elsif range_points = value.match(NUMERICAL_RANGE)
+      exclusive        = value.include?('...')
+      starting_point   = string_to_number(range_points[1])
+      ending_point     = string_to_number(range_points[2])
+
+      ::Range.new(starting_point, ending_point, exclusive)
+    elsif value.match?(FLOAT)
+      Float(value.delete('_'))
+    elsif value.match?(INTEGER)
+      Integer(value.delete('_'))
+    elsif value.match?(ISO8601)
+      ::Time.iso8601(value)
+    else
+      value
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  # rubocop:enable Lint/AssignmentInCondition, Metrics/AbcSize,
+
+  def string_to_number(other)
+    other = other.delete('_')
+
+    if other == 'Infinity'
+      9_999_999
+    elsif other.match?(FLOAT)
+      other.to_f
+    elsif other.match?(INTEGER)
+      other.to_i
+    end
+  end
+end
+end
+end

data/lib/apiphobic/parameters/include.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module  Apiphobic
+module  Parameters
+class   Include
+  attr_accessor :raw_parameters
+
+  def initialize(raw_parameters)
+    self.raw_parameters = raw_parameters ? raw_parameters.split(',') : []
+  end
+
+  def present?
+    raw_parameters.any?
+  end
+
+  def to_a
+    @to_a ||= map_inclusions(
+                raw_parameters
+                  .reject(&:empty?)
+                  .compact,
+              )
+  end
+
+  private
+
+  # rubocop:disable Metrics/PerceivedComplexity,
+  # rubocop:disable Metrics/BlockNesting
+  def map_inclusions(array)
+    mapped = array.each_with_object([{}]) do |inclusion, memo|
+      if inclusion.is_a?(::Hash)
+        memo[0] = inclusion
+      else
+        first, _match, rest = inclusion.partition('.')
+
+        if rest == ''
+          memo << first
+        else
+          memo.delete(first)
+
+          memo[0][first] = if memo[0][first].nil?
+                             rest
+                           else
+                             map_inclusions(Array(memo[0][first]) << rest)
+                           end
+        end
+      end
+    end
+
+    mapped.shift if mapped[0] == {}
+
+    mapped
+  end
+  # rubocop:enable Metrics/BlockNesting
+  # rubocop:enable Metrics/PerceivedComplexity,
+end
+end
+end

data/lib/apiphobic/parameters/index.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module  Apiphobic
+module  Parameters
+class   Index
+  DEFAULT_QUERY = '*'
+
+  attr_accessor :raw_parameters
+
+  def initialize(raw_parameters)
+    self.raw_parameters = raw_parameters || {}
+  end
+
+  def present?
+    query
+  end
+
+  def query
+    compacted_parameters['query'] || compacted_parameters['q']
+  end
+
+  private
+
+  def compacted_parameters
+    @compacted_parameters ||= raw_parameters.reject do |_name, value|
+      value == '' ||
+      value.nil?
+    end
+  end
+end
+end
+end

data/lib/apiphobic/parameters/page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module  Apiphobic
+module  Parameters
+class   Page
+  PAGING_PARAMETERS     = %w{number size limit offset cursor}.freeze
+  DEFAULT_STARTING_PAGE = 1
+  DEFAULT_PAGE_SIZE     = 25
+  DEFAULT_OFFSET        = 0
+
+  attr_accessor :raw_parameters
+
+  def initialize(raw_parameters)
+    self.raw_parameters = raw_parameters || {}
+  end
+
+  def present?
+    (raw_parameters.keys & PAGING_PARAMETERS).any?
+  end
+
+  def page_number
+    raw_parameters['number'] || DEFAULT_STARTING_PAGE
+  end
+
+  def per_page
+    raw_parameters['size'] || raw_parameters['limit'] || DEFAULT_PAGE_SIZE
+  end
+
+  def offset
+    raw_parameters['offset'] || DEFAULT_OFFSET
+  end
+end
+end
+end

data/lib/apiphobic/parameters/sort.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module  Apiphobic
+module  Parameters
+class   Sort
+  DESCENDING_PREFIX = '-'
+
+  attr_accessor :raw_parameters
+
+  def initialize(raw_parameters)
+    self.raw_parameters = raw_parameters ? raw_parameters.split(',') : []
+  end
+
+  def present?
+    raw_parameters.any?
+  end
+
+  def to_h
+    @to_h ||= Hash[to_a]
+  end
+
+  def to_a
+    @to_a ||= raw_parameters.map do |raw_parameter|
+      if raw_parameter.start_with?(DESCENDING_PREFIX)
+        [raw_parameter[1..-1], 'desc']
+      else
+        [raw_parameter, 'asc']
+      end
+    end
+  end
+end
+end
+end

data/lib/apiphobic/resource/collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'apiphobic/resource/model'
+
+module  Apiphobic
+module  Resource
+class   Collection < Resource::Model
+  DEFAULT_PROCESSORS = %w{including filtering sorting paging indexing}.freeze
+end
+end
+end

data/lib/apiphobic/resource/model.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'apiphobic/resource/processors/filtering'
+require 'apiphobic/resource/processors/including'
+require 'apiphobic/resource/processors/indexing'
+require 'apiphobic/resource/processors/paging'
+require 'apiphobic/resource/processors/sorting'
+
+module  Apiphobic
+module  Resource
+class   Model
+  DEFAULT_PROCESSORS = %w{including}.freeze
+
+  attr_accessor :resource,
+                :parameters
+  attr_reader   :processors
+
+  def initialize(resource:, parameters:, **options)
+    self.resource   = resource
+    self.parameters = parameters.dup
+    self.processors = options.fetch(:processors, self.class::DEFAULT_PROCESSORS)
+  end
+
+  def processed
+    @processed ||= processors.inject(resource) do |processed_resource, processor|
+      processor.processed(processed_resource, parameters)
+    end
+  end
+
+  def meta
+    @meta ||= processors.inject({}) do |metadata, processor|
+      metadata.merge processor.meta(processed, parameters)
+    end
+  end
+
+  def processors=(other)
+    @processors = other.map do |processor|
+      Object.const_get("::Apiphobic::Resource::Processors::#{processor.capitalize}")
+    end
+  end
+end
+end
+end

data/lib/apiphobic/resource/processors/filtering.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'apiphobic/parameters/filter'
+
+module Apiphobic
+module Resource
+module Processors
+class  Filtering
+  attr_accessor :resource,
+                :parameters
+
+  # rubocop:disable Style/OptionHash
+  def initialize(resource, parameters = {})
+    self.resource   = resource
+    self.parameters = Parameters::Filter.new(parameters['filter'] || {})
+  end
+  # rubocop:enable Style/OptionHash
+
+  def self.processed(*attrs)
+    new(*attrs).processed
+  end
+
+  def self.meta(*_attrs)
+    {}
+  end
+
+  def processed
+    parameters.each_with_object(resource) do |(name, value), filtered_resource|
+      filter_method = filter_method_for(name)
+
+      if !filter_method
+        filtered_resource
+      elsif filter_method.arity.zero?
+        filtered_resource.public_send(filter_method.name)
+      else
+        filtered_resource.public_send(filter_method.name, value)
+      end
+    end
+
+    resource
+  end
+
+  private
+
+  def filter_method_for(filter_item)
+    filter_method_name = filter_method_name_for(filter_item)
+
+    resource_class.method(filter_method_name) if filter_method_name
+  end
+
+  def filter_method_name_for(filter_item)
+    if resource_class.respond_to? "for_#{filter_item}"
+      "for_#{filter_item}"
+    elsif resource_class.respond_to? filter_item
+      filter_item
+    end
+  end
+
+  def resource_class
+    @resource_class ||= if resource.respond_to? :klass
+                          resource.klass
+                        else
+                          resource
+                        end
+  end
+end
+end
+end
+end

data/lib/apiphobic/resource/processors/including.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'apiphobic/parameters/include'
+
+module  Apiphobic
+module  Resource
+module  Processors
+class   Including
+  attr_accessor :resource,
+                :parameters
+
+  # rubocop:disable Style/OptionHash
+  def initialize(resource, parameters = {})
+    self.resource   = resource
+    self.parameters = Parameters::Include.new(parameters['include'])
+  end
+  # rubocop:enable Style/OptionHash
+
+  def self.processed(*attrs)
+    new(*attrs).processed
+  end
+
+  def self.meta(*_attrs)
+    {}
+  end
+
+  def processed
+    return resource unless parameters.present?
+
+    resource.includes(*parameters.to_a)
+
+    resource
+  end
+
+  def meta
+    {}
+  end
+end
+end
+end
+end

data/lib/apiphobic/resource/processors/indexing.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'apiphobic/parameters/index'
+
+module Apiphobic
+module Resource
+module Processors
+class  Indexing
+  attr_accessor :resource,
+                :parameters
+
+  # rubocop:disable Style/OptionHash
+  def initialize(resource, parameters = {})
+    self.resource   = resource
+    self.parameters = Parameters::Index.new(parameters['filter'] || {})
+  end
+  # rubocop:enable Style/OptionHash
+
+  def self.processed(*attrs)
+    new(*attrs).processed
+  end
+
+  def self.meta(*_attrs)
+    {}
+  end
+
+  def processed
+    return resource unless parameters.present? || force_query
+
+    resource.for_query(parameters.query || Parameters::Index::DEFAULT_QUERY)
+  end
+
+  private
+
+  def force_query
+    resource.class.name.include? 'Index'
+  end
+end
+end
+end
+end

data/lib/apiphobic/resource/processors/paging.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'apiphobic/parameters/page'
+
+module  Apiphobic
+module  Resource
+module  Processors
+class   Paging
+  attr_accessor :resource,
+                :parameters
+
+  # rubocop:disable Style/OptionHash
+  def initialize(resource, parameters = {})
+    self.resource   = resource
+    self.parameters = Parameters::Page.new(parameters['page'] || {})
+  end
+  # rubocop:enable Style/OptionHash
+
+  def self.processed(*attrs)
+    new(*attrs).processed
+  end
+
+  def self.meta(*attrs)
+    new(*attrs).meta
+  end
+
+  def processed
+    return resource unless parameters.present?
+
+    resource
+      .page(parameters.page_number)
+      .per(parameters.per_page)
+  end
+
+  def meta
+    return {} unless parameters.present?
+
+    {
+      'total-pages'   => resource.total_pages,
+      'current-page'  => resource.current_page,
+      'previous-page' => resource.prev_page,
+      'next-page'     => resource.next_page,
+    }
+  end
+end
+end
+end
+end

data/lib/apiphobic/resource/processors/sorting.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'apiphobic/parameters/sort'
+
+module  Apiphobic
+module  Resource
+module  Processors
+class   Sorting
+  attr_accessor :resource,
+                :parameters
+
+  # rubocop:disable Style/OptionHash
+  def initialize(resource, parameters = {})
+    self.resource   = resource
+    self.parameters = Parameters::Sort.new(parameters['sort'])
+  end
+  # rubocop:enable Style/OptionHash
+
+  def self.processed(*attrs)
+    new(*attrs).processed
+  end
+
+  def self.meta(*attrs)
+    new(*attrs).meta
+  end
+
+  def processed
+    return resource unless parameters.present?
+
+    resource.order(parameters.to_h)
+
+    resource
+  end
+
+  def meta
+    return {} unless parameters.present?
+
+    {
+      'sort' => parameters.to_h,
+    }
+  end
+end
+end
+end
+end

data/lib/apiphobic/resource/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Apiphobic
+module Resource
+  VERSION = '1.0.0'
+end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: apiphobic-resource
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- thegranddesign
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDqjCCApKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBNMREwDwYDVQQDDAhydWJ5
+  Z2VtczEjMCEGCgmSJomT8ixkARkWE2xpdmluZ2hpZ2hvbnRoZWJsb2cxEzARBgoJ
+  kiaJk/IsZAEZFgNjb20wHhcNMTcwODAyMjI1OTM1WhcNMTgwODAyMjI1OTM1WjBN
+  MREwDwYDVQQDDAhydWJ5Z2VtczEjMCEGCgmSJomT8ixkARkWE2xpdmluZ2hpZ2hv
+  bnRoZWJsb2cxEzARBgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUA
+  A4IBDwAwggEKAoIBAQDtLa7+7p49gW15OgOyRZad/F92iZcMdDjZ2kAxZlviXgVe
+  PCtjfdURobH+YMdt++6eRkE25utIFqHyN51Shxfdc21T3fPQe/ZEoMyiJK4tYzbh
+  7VjNJG4ldvKKpS1p7iVz9imnyTxNwb0JaIOsOFCA04T0u6aCQi2acNvAPLviXk0q
+  xJ/CKjI4QUTZKVrBt8Q1Egrp2yzmEnSNftDuTbBb8m4vDR+w325CwbKCgycHJ1/g
+  YZ3FO76TzJuRVbsYS/bU5XKHVEpkeFmWBqEXsk4DuUIWLa6WZEJcoZf+YP+1pycG
+  7YqSbydpINtEdopD+EEI+g+zNJ4nSI8/eQcQyEjBAgMBAAGjgZQwgZEwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFDWuVrg4ve0vLu71kqiGdyBnzJGV
+  MCsGA1UdEQQkMCKBIHJ1YnlnZW1zQGxpdmluZ2hpZ2hvbnRoZWJsb2cuY29tMCsG
+  A1UdEgQkMCKBIHJ1YnlnZW1zQGxpdmluZ2hpZ2hvbnRoZWJsb2cuY29tMA0GCSqG
+  SIb3DQEBBQUAA4IBAQDJIpHjbBPGiaY4wOHcXlltQ+BMmhWQNh+1fZtyajQd+7Ay
+  fv23mO7Mf25Q38gopQlpaODkfxq54Jt8FvQbr5RYRS4j+JEKb75NgrAtehd8USUd
+  CiJJGH+yvGNWug9IGZCGX91HIbTsLQ5IUUWQasC5jGP8nxXufUr9xgAJZZenewny
+  B2qKu8q1A/kj6cw62RCY7yBmUXxlcJBj8g+JKYAFbYYKUdQSzf50k9IiWLWunJM+
+  Y2GAoHKstmfIVhc4XHOPpmTd2o/C29O9oaRgjrkfQEhF/KvJ/PhoV5hvokzsCyI5
+  iUeXPfvrGD/itYIBCgk+fnzyQQ4QtE5hTQaWQ3o2
+  -----END CERTIFICATE-----
+date: 2018-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspeckled
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: ''
+email:
+- rubygems@livinghighontheblog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/apiphobic-resource.rb
+- lib/apiphobic/parameters/filter.rb
+- lib/apiphobic/parameters/include.rb
+- lib/apiphobic/parameters/index.rb
+- lib/apiphobic/parameters/page.rb
+- lib/apiphobic/parameters/sort.rb
+- lib/apiphobic/resource/collection.rb
+- lib/apiphobic/resource/model.rb
+- lib/apiphobic/resource/processors/filtering.rb
+- lib/apiphobic/resource/processors/including.rb
+- lib/apiphobic/resource/processors/indexing.rb
+- lib/apiphobic/resource/processors/paging.rb
+- lib/apiphobic/resource/processors/sorting.rb
+- lib/apiphobic/resource/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: API Resources
+test_files: []