munson 0.2.0 → 0.3.0

data/lib/munson.rb

@@ -2,25 +2,46 @@ require 'json'
 require 'cgi'
 require 'faraday'
 require 'faraday_middleware'
+require 'bigdecimal'
 
 require "munson/version"
-
-require "munson/middleware/encode_json_api"
-require "munson/middleware/json_parser"
-
+require 'munson/agent'
+require 'munson/attribute'
+require "munson/client"
 require 'munson/collection'
-require 'munson/paginator'
-require 'munson/response_mapper'
-require 'munson/query_builder'
 require 'munson/connection'
-require 'munson/agent'
+require 'munson/document'
+require 'munson/key_formatter'
+require "munson/middleware/encode_json_api"
+require "munson/middleware/json_parser"
 require 'munson/resource'
+require 'munson/response_mapper'
+require 'munson/query'
 
 module Munson
+  class Error < StandardError; end;
+  class UnsupportedSortDirectionError < Munson::Error; end;
+  class UnrecognizedKeyFormatter < Munson::Error; end;
+  class RelationshipNotIncludedError < Munson::Error; end;
+  class RelationshipNotFound < Munson::Error; end;
+  class ClientNotSet < Munson::Error; end;
   @registered_types = {}
-  @registered_paginators = {}
 
   class << self
+    # Transforms a JSONAPI hash into a Munson::Document, Munson::Resource, or arbitrary class
+    # @param [Munson::Document,Hash] document to transform
+    # @return [Munson::Document,~Munson::Resource]
+    def factory(document)
+      document = Munson::Document.new(document) if document.is_a?(Hash)
+      klass    = Munson.lookup_type(document.type)
+
+      if klass && klass.respond_to?(:munson_initializer)
+        klass.munson_initializer(document)
+      else
+        document
+      end
+    end
+
     # Configure the default connection.
     #
     # @param [Hash] opts {Munson::Connection} configuration options
@@ -52,14 +73,6 @@ module Munson
       @registered_types[type.to_sym] = klass
     end
 
-    def register_paginator(name, klass)
-      @registered_paginators[name.to_sym] = klass
-    end
-
-    def lookup_paginator(name)
-      @registered_paginators[name.to_sym]
-    end
-
     # Lookup a class by JSON Spec type name
     #
     # @param [#to_sym] type JSON Spec type
@@ -67,10 +80,5 @@ module Munson
     def lookup_type(type)
       @registered_types[type.to_sym]
     end
-
-    # @private
-    def flush_types!
-      @registered_types = {}
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: munson
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cory O'Daniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,15 +182,15 @@ files:
 - bin/setup
 - lib/munson.rb
 - lib/munson/agent.rb
+- lib/munson/attribute.rb
+- lib/munson/client.rb
 - lib/munson/collection.rb
 - lib/munson/connection.rb
+- lib/munson/document.rb
+- lib/munson/key_formatter.rb
 - lib/munson/middleware/encode_json_api.rb
 - lib/munson/middleware/json_parser.rb
-- lib/munson/model.rb
-- lib/munson/paginator.rb
-- lib/munson/paginator/offset_paginator.rb
-- lib/munson/paginator/paged_paginator.rb
-- lib/munson/query_builder.rb
+- lib/munson/query.rb
 - lib/munson/resource.rb
 - lib/munson/response_mapper.rb
 - lib/munson/version.rb

data/lib/munson/model.rb

@@ -1,15 +0,0 @@
-# module Munson
-#   module Model
-#     extend ActiveSupport::Concern
-#
-#     included do
-#       self.include Munson::Resource
-#     end
-#
-#     class_methods do
-#       def has_many(*);end;
-#       def has_one(*);end;
-#       def belongs_to(*);end;
-#     end
-#   end
-# end

data/lib/munson/paginator/offset_paginator.rb

@@ -1,45 +0,0 @@
-module Munson
-  module Paginator
-    class OffsetPaginator
-      def initialize(options={})
-        @max_limit = options[:max]
-        @default_limit = options[:default]
-      end
-
-      def set(opts={})
-        limit(opts[:limit]) if opts[:limit]
-        offset(opts[:offset]) if opts[:offset]
-      end
-
-      def to_params
-        {
-          page: {
-            limit: @limit || @default_limit || 10,
-            offset: @offset
-          }.select { |_, value| !value.nil? }
-        }
-      end
-
-      private
-
-      # Set limit of resources per page
-      #
-      # @param [Fixnum] num number of resources per page
-      def limit(num)
-        if @max_limit && num > @max_limit
-          @limit = @max_limit
-        else
-          @limit = num
-        end
-      end
-
-      # Set offset
-      #
-      # @param [Fixnum] num pages to offset
-      def offset(num)
-        @offset = num
-      end
-    end
-  end
-end
-Munson.register_paginator(:offset, Munson::Paginator::OffsetPaginator)

data/lib/munson/paginator/paged_paginator.rb

@@ -1,47 +0,0 @@
-module Munson
-  module Paginator
-    class PagedPaginator
-      def initialize(options={})
-        @max_size = options[:max]
-        @default_size = options[:default]
-      end
-
-      def set(opts={})
-        number(opts[:number]) if opts[:number]
-        size(opts[:size]) if opts[:size]
-      end
-
-      def to_params
-        {
-          page: {
-            size: @size || @default_size || 10,
-            number: @number
-          }.select { |_, value| !value.nil? }
-        }
-      end
-
-      private
-
-      # Set number of resources per page
-      #
-      # @param [Fixnum] num number of resources per page
-      def size(num)
-        if @max_size && num > @max_size
-          @size = @max_size
-        else
-          @size = num
-        end
-      end
-
-      # Set page number
-      #
-      # @param [Fixnum] num page number
-      def number(num)
-        @number = num
-      end
-
-    end
-  end
-end
-
-Munson.register_paginator(:paged, Munson::Paginator::PagedPaginator)

data/lib/munson/paginator.rb

@@ -1,6 +0,0 @@
-module Munson
-  module Paginator
-    autoload :OffsetPaginator, "munson/paginator/offset_paginator"
-    autoload :PagedPaginator, "munson/paginator/paged_paginator"
-  end
-end

data/lib/munson/query_builder.rb

@@ -1,226 +0,0 @@
-module Munson
-  class QueryBuilder
-    attr_reader :query
-    attr_reader :paginator
-    attr_reader :agent
-    class UnsupportedSortDirectionError < StandardError; end;
-    class PaginatorNotSet < StandardError; end;
-    class AgentNotSet < StandardError; end;
-
-    # Description of method
-    #
-    # @param [Class] paginator: nil instantiated paginator
-    # @param [Class] agent: nil instantiated agent to use for fetching results
-    # @return [Type] description of returned object
-    def initialize(paginator: nil, agent: nil)
-      @paginator = paginator
-      @agent = agent
-
-      @query = {
-        include: [],
-        fields:  [],
-        filter:  [],
-        sort:    []
-      }
-    end
-
-    # @return [String] query as a query string
-    def to_query_string
-      Faraday::Utils.build_nested_query(to_params)
-    end
-
-    def to_s
-      to_query_string
-    end
-
-    def to_params
-      str = {}
-      str[:filter] = filter_to_query_value unless @query[:filter].empty?
-      str[:fields] = fields_to_query_value unless @query[:fields].empty?
-      str[:include] = includes_to_query_value unless @query[:include].empty?
-      str[:sort] = sort_to_query_value unless @query[:sort].empty?
-
-      str.merge!(paginator.to_params) if paginator
-
-      str
-    end
-
-    # Fetches resources using {Munson::Agent}
-    #
-    # @return [Array] Array of resources
-    def fetch
-      if @agent
-        response = @agent.get(params: to_params)
-        resources = ResponseMapper.new(response).resources
-        Collection.new(resources)
-      else
-        raise AgentNotSet, "Agent was not set. QueryBuilder#new(agent:)"
-      end
-    end
-
-    def paging?
-      !!paginator
-    end
-
-    # Paginator proxy
-    #
-    # @return [Class,nil] paginator if set
-    def page(opts={})
-      if paging?
-        paginator.set(opts)
-        self
-      else
-        raise PaginatorNotSet, "Paginator was not set. QueryBuilder#new(paginator:)"
-      end
-    end
-
-    # Chainably include related resources.
-    #
-    # @example including a resource
-    #   Munson::QueryBuilder.new.includes(:user)
-    #
-    # @example including a related resource
-    #   Munson::QueryBuilder.new.includes("user.addresses")
-    #
-    # @example including multiple resources
-    #   Munson::QueryBuilder.new.includes("user.addresses", "user.images")
-    #
-    # @param [Array<String,Symbol>] *args relationships to include
-    # @return [Munson::QueryBuilder] self for chaining queries
-    #
-    # @see http://jsonapi.org/format/#fetching-includes JSON API Including Relationships
-    def includes(*args)
-      @query[:include] += args
-      self
-    end
-
-    # Chainably sort results
-    # @note Default order is ascending
-    #
-    # @example sorting by a single field
-    #   Munsun::QueryBuilder.new.sort(:created_at)
-    #
-    # @example sorting by a multiple fields
-    #   Munsun::QueryBuilder.new.sort(:created_at, :age)
-    #
-    # @example specifying sort direction
-    #   Munsun::QueryBuilder.new.sort(:created_at, age: :desc)
-    #
-    # @example specifying sort direction
-    #   Munsun::QueryBuilder.new.sort(score: :desc, :created_at)
-    #
-    # @param [Hash<Symbol,Symbol>, Symbol] *args fields to sort by
-    # @return [Munson::QueryBuilder] self for chaining queries
-    #
-    # @see http://jsonapi.org/format/#fetching-sorting JSON API Sorting Spec
-    def sort(*args)
-      validate_sort_args(args.select{|arg| arg.is_a?(Hash)})
-      @query[:sort] += args
-      self
-    end
-
-    # Hash resouce_name: [array of attribs]
-    def fields(*args)
-      @query[:fields] += args
-      self
-    end
-
-    def filter(*args)
-      @query[:filter] += args
-      self
-    end
-
-    def self.includes(*args)
-      new.includes(*args)
-    end
-
-    def self.sort(*args)
-      new.sort(*args)
-    end
-
-    def self.fields(*args)
-      new.fields(*args)
-    end
-
-    def self.filter(*args)
-      new.filter(*args)
-    end
-
-    protected
-
-    def sort_to_query_value
-      @query[:sort].map{|item|
-        if item.is_a?(Hash)
-          item.to_a.map{|name,dir|
-            dir.to_sym == :desc ? "-#{name}" : name.to_s
-          }
-        else
-          item.to_s
-        end
-      }.join(',')
-    end
-
-    def fields_to_query_value
-      @query[:fields].inject({}) do |acc, hash_arg|
-        hash_arg.each do |k,v|
-          acc[k] ||= []
-          v.is_a?(Array) ?
-            acc[k] += v :
-            acc[k] << v
-
-          acc[k].map(&:to_s).uniq!
-        end
-
-        acc
-      end.map { |k, v| [k, v.join(',')] }.to_h
-    end
-
-    def includes_to_query_value
-      @query[:include].map(&:to_s).sort.join(',')
-    end
-
-    # Since the filter query param's format isn't specified in the [spec](http://jsonapi.org/format/#fetching-filtering)
-    # this implemenation uses (JSONAPI::Resource's implementation](https://github.com/cerebris/jsonapi-resources#filters)
-    #
-    # To override, implement your own CustomQueryBuilder inheriting from {Munson::QueryBuilder}
-    # {Munson::Agent} takes a QueryBuilder class to use. This method could be overriden in your custom class
-    #
-    # @example Custom Query Builder
-    #   class MyBuilder < Munson::QueryBuilder
-    #     def filter_to_query_value
-    #       # ... your fancier logic
-    #     end
-    #   end
-    #
-    #   class Article
-    #     def self.munson
-    #       return @munson if @munson
-    #       @munson = Munson::Agent.new(
-    #         query_builder: MyBuilder
-    #         path: 'products'
-    #       )
-    #     end
-    #   end
-    #
-    def filter_to_query_value
-      @query[:filter].reduce({}) do |acc, hash_arg|
-        hash_arg.each do |k,v|
-          acc[k] ||= []
-          v.is_a?(Array) ? acc[k] += v : acc[k] << v
-          acc[k].uniq!
-        end
-        acc
-      end.map { |k, v| [k, v.join(',')] }.to_h
-    end
-
-    def validate_sort_args(hashes)
-      hashes.each do |hash|
-        hash.each do |k,v|
-          if !%i(desc asc).include?(v.to_sym)
-            raise UnsupportedSortDirectionError, "Unknown direction '#{v}'. Use :asc or :desc"
-          end
-        end
-      end
-    end
-  end
-end