munson 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77ac2773bff30e5728d4a9e4233c8d4249e549de
-  data.tar.gz: 401d3dd17993b1b6fe4bc37ad9389304bbcb8afb
+  metadata.gz: 58f61fc4c3adf530a74a67fe73b0c1907e097a3a
+  data.tar.gz: c0dfb862271eee803921d1a9772514de40f8d669
 SHA512:
-  metadata.gz: 1b1ae060b21129c271dd32475f84305b8481577b9c0aa7831352aa3cdfae3918103cf79ed02dd4a1040f63916286cac7a111c7cd9914e5187d57caf9ebcd8ccd
-  data.tar.gz: 3d0b4b589d45b5df66f9203e3fed3a3745c5addf09e63d4db172a13d0020ba815162d68891f30132635e9e84e3ddff2b899078e485fabf4cc37d11f2cc92fe11
+  metadata.gz: 59c16ff0e3445ebdc0f9adc4b422537714e0767a0a780533f2b682a08ce1ce2de0cf3af0cb88672c2b2d7fa96dc7a781a42692665f9e832033480f90fbbcf0ec
+  data.tar.gz: fae8f69311ed2cbec3efc7397c8c2c8c01165b0c493b77e4f4c80805c07aee9b0fb798cbbf8dee8b2d06af3dcf70dd803bd4f74323081460ead7e294f9b4ea4c

data/README.md

@@ -2,6 +2,7 @@
 
 [![Code Climate](https://codeclimate.com/github/coryodaniel/munson/badges/gpa.svg)](https://codeclimate.com/github/coryodaniel/munson)
 [![Test Coverage](https://codeclimate.com/github/coryodaniel/munson/badges/coverage.svg)](https://codeclimate.com/github/coryodaniel/munson/coverage)
+![Build Status](https://travis-ci.org/coryodaniel/munson.svg?branch=master)
 
 A JSON API Spec client for Ruby
 
@@ -58,7 +59,7 @@ class Product
     @munson = Munson::Agent.new(
       connection: Munson.default_connection, # || Munson::Connection.new(...)
       paginator: :offset,
-      path: 'products'
+      type: 'products'
     )
   end
 end
@@ -160,7 +161,7 @@ class Product
     return @munson if @munson
     @munson = Munson::Agent.new(
       paginator: :offset,
-      path: 'products'
+      type: 'products'
     )
   end
 end
@@ -179,7 +180,7 @@ class Product
     return @munson if @munson
     @munson = Munson::Agent.new(
       paginator: :paged,
-      path: 'products'
+      type: 'products'
     )
   end
 end
@@ -224,17 +225,34 @@ when using the bare Munson::Agent, Munson::Resource will pass the JSON Spec attr
 ```ruby
 class Product
   include Munson::Resource
+  register_munson_type :products
 end
 
 # Munson method is there, should you be looking for it.
 Product.munson #=> Munson::Agent
 ```
 
-Changing the type name:
+**Setting the type**
+
+This will cause Munson to return a hash instead of a class instance (Product).
+
 ```ruby
 class Product
   include Munson::Resource
-  munson.type = "things"
+  munson.type = :products
+end
+```
+
+There are two ways to set the JSON API type when using a Munson::Resource
+
+**Registering the type**
+
+This will cause munson to return your model's datatype. Munson will register this in its type map dictionary and use the class to initialize a model
+
+```ruby
+class Product
+  include Munson::Resource
+  register_munson_type :products
 end
 ```
 
@@ -354,3 +372,55 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/coryodaniel/munson.
+
+### Munson::Model
+WIP see [usage](#usage)
+
+Finding related resources could set instance methods that mix/override behavior of the class level agent...
+
+/articles/1
+Article.find(1) uses Article.munson
+
+/articles/1/author
+article = Article.find(1) uses Article.munson
+article.author uses article.munson as a new connection that sets the base uri to /articles/1
+
+## Usage
+```ruby
+address = Address.new
+address.state = "FL"
+address.save
+address.state = "CA"
+address.save
+# Mind mutex adding method accessors on... dangerous, see her, consider storing them in an @attributes hash...
+user = User.find(1)
+address = user.addresses.build
+address.save #posts on the relation
+
+address = Address.new({...})
+address = Address.new
+address.assign_attributes
+address.update_attributes
+address.dirty?
+
+Address.update(1, {}) #update without loading
+Address.destroy(1) #Destroy without loading
+
+address = Address.find(300)
+address.destroy
+
+Address.find(10)
+Address.filter(zip_code: 90210).find(10)
+Address.filter(zip_code: 90210).all
+Address.filter(zip_code: 90210).fetch
+Address.includes(:user, 'user.purchases').filter(active: true).all
+Address.includes(:user, 'user.purchases').find(10)
+Address.sort(city: :asc)
+Address.sort(city: :desc)
+Address.fields(:street1, :street2, {user: :name})
+Address.fields(:street1, :street2).fields(user: :name)
+addresses = Address.fields(:street1, :street2).fields(user: :name)
+addresses.first.shipped_products.filter(min_total: 300.00)
+
+Custom collection/member methods?
+```

data/lib/munson.rb

@@ -1,9 +1,5 @@
 require 'json'
-
-require 'active_support/concern'
-require "active_support/inflector"
-require "active_support/core_ext/hash"
-
+require 'cgi'
 require 'faraday'
 require 'faraday_middleware'
 
@@ -22,6 +18,8 @@ require 'munson/resource'
 
 module Munson
   @registered_types = {}
+  @registered_paginators = {}
+
   class << self
     # Configure the default connection.
     #
@@ -48,18 +46,26 @@ module Munson
     # @example Mapping a type
     #   Munson.register_type("addresses", Address)
     #
-    # @param [#to_s] type JSON Spec type
+    # @param [#to_sym] type JSON Spec type
     # @param [Class] klass to map to
     def register_type(type, klass)
-      @registered_types[type] = klass
+      @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_s] type JSON Spec type
+    # @param [#to_sym] type JSON Spec type
     # @return [Class] domain model
     def lookup_type(type)
-      @registered_types[type]
+      @registered_types[type.to_sym]
     end
 
     # @private

data/lib/munson/agent.rb

@@ -31,7 +31,7 @@ module Munson
 
     def paginator=(pager)
       if pager.is_a?(Symbol)
-        @paginator = "Munson::Paginator::#{pager.to_s.classify}Paginator".constantize
+        @paginator = Munson.lookup_paginator(pager)
       else
         @paginator = pager
       end

data/lib/munson/middleware/encode_json_api.rb

@@ -4,8 +4,10 @@ module Munson
       CONTENT_TYPE = 'Content-Type'.freeze
       ACCEPT       = 'Accept'.freeze
       MIME_TYPE    = 'application/vnd.api+json'.freeze
+      USER_AGENT   = 'User-Agent'
 
       def call(env)
+        env[:request_headers][USER_AGENT] = "Munson v#{Munson::VERSION}"
         env[:request_headers][ACCEPT] ||= MIME_TYPE
         match_content_type(env) do |data|
           env[:body] = encode data

data/lib/munson/paginator/offset_paginator.rb

@@ -16,7 +16,7 @@ module Munson
           page: {
             limit: @limit || @default_limit || 10,
             offset: @offset
-          }.compact
+          }.select { |_, value| !value.nil? }
         }
       end
 
@@ -42,3 +42,4 @@ module Munson
     end
   end
 end
+Munson.register_paginator(:offset, Munson::Paginator::OffsetPaginator)

data/lib/munson/paginator/paged_paginator.rb

@@ -16,7 +16,7 @@ module Munson
           page: {
             size: @size || @default_size || 10,
             number: @number
-          }.compact
+          }.select { |_, value| !value.nil? }
         }
       end
 
@@ -43,3 +43,5 @@ module Munson
     end
   end
 end
+
+Munson.register_paginator(:paged, Munson::Paginator::PagedPaginator)

data/lib/munson/query_builder.rb

@@ -26,11 +26,11 @@ module Munson
 
     # @return [String] query as a query string
     def to_query_string
-      to_params.to_query
+      Faraday::Utils.build_nested_query(to_params)
     end
 
     def to_s
-      to_query
+      to_query_string
     end
 
     def to_params

data/lib/munson/resource.rb

@@ -1,19 +1,21 @@
 module Munson
   module Resource
-    extend ActiveSupport::Concern
+    def self.included(base)
+      base.extend ClassMethods
+    end
 
-    included do
-      def self.munson
+    module ClassMethods
+      def munson
         return @munson if @munson
         @munson = Munson::Agent.new
         @munson
       end
+      
+      def register_munson_type(name)
+        Munson.register_type(name, self)
+        self.munson.type = name
+      end
 
-      self.munson.type = name.demodulize.tableize
-      Munson.register_type(self.munson.type, self)
-    end
-
-    class_methods do
       [:includes, :sort, :filter, :fields, :fetch, :find, :page].each do |method|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*args)

data/lib/munson/version.rb

@@ -1,3 +1,3 @@
 module Munson
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/munson.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
-  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -29,6 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'yard-activesupport-concern'
   spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: munson
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cory O'Daniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard-activesupport-concern
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement