munson 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77ac2773bff30e5728d4a9e4233c8d4249e549de
+  data.tar.gz: 401d3dd17993b1b6fe4bc37ad9389304bbcb8afb
+SHA512:
+  metadata.gz: 1b1ae060b21129c271dd32475f84305b8481577b9c0aa7831352aa3cdfae3918103cf79ed02dd4a1040f63916286cac7a111c7cd9914e5187d57caf9ebcd8ccd
+  data.tar.gz: 3d0b4b589d45b5df66f9203e3fed3a3745c5addf09e63d4db172a13d0020ba815162d68891f30132635e9e84e3ddff2b899078e485fabf4cc37d11f2cc92fe11

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in munson.gemspec
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,356 @@
+# Munson
+
+[![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)
+
+A JSON API Spec client for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'munson'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install munson
+
+## Usage
+
+### Munson::Connection and configuring the default connection
+
+Munson is designed to support multiple connections or API endpoints. A connection is a wrapper around Faraday::Connection that includes a few pieces of middleware for parsing and encoding requests and responses to JSON API Spec.
+
+```ruby
+Munson.configure(url: 'http://api.example.com') do |c|
+  c.use MyCustomMiddleware
+end
+```
+
+Options can be any [Faraday::Connection options](https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb Faraday::Connection)
+
+Additional connections can be created with:
+```ruby
+my_connection = Munson::Connection.new(url: 'http://api2.example.com') do |c|
+  c.use MoreMiddleware
+  c.use AllTheMiddlewares
+end
+```
+
+### Munson::Agent
+
+Munson::Agent provides a small 'DSL' to build requests and parse responses,
+while allowing additional configuration for a particular 'resource.'
+
+
+```ruby
+Munson.configure url: 'http://api.example.com'
+
+class Product
+  def self.munson
+    return @munson if @munson
+    @munson = Munson::Agent.new(
+      connection: Munson.default_connection, # || Munson::Connection.new(...)
+      paginator: :offset,
+      path: 'products'
+    )
+  end
+end
+```
+
+#### Getting the faraday response
+```ruby
+query = Product.munson.filter(min_price: 30, max_price: 65)
+# its chainable
+query.filter(category: 'Hats').filter(size: ['small', 'medium'])
+
+query.to_params
+#=> {:filter=>{:min_price=>"30", :max_price=>"65", :category=>"Hats", :size=>"small,medium"}}
+
+Product.munson.get(params: query.to_params)
+```
+
+#### Filtering
+
+```ruby
+query = Product.munson.filter(min_price: 30, max_price: 65)
+# its chainable
+query.filter(category: 'Hats').filter(size: ['small', 'medium'])
+
+query.to_params
+#=> {:filter=>{:min_price=>"30", :max_price=>"65", :category=>"Hats", :size=>"small,medium"}}
+
+query.fetch #=> Some lovely data
+```
+
+#### Sorting
+
+```ruby
+query = Product.munson.sort(created_at: :desc)
+# its chainable
+query.sort(:price) # defaults to ASC
+
+query.to_params
+#=> {:sort=>"-created_at,price"}
+
+query.fetch #=> Some lovely data
+```
+
+#### Including (Side loading related resources)
+
+```ruby
+query = Product.munson.includes(:manufacturer)
+# its chainable
+query.includes(:vendor)
+
+query.to_params
+#=> {:include=>"manufacturer,vendor"}
+
+query.fetch #=> Some lovely data
+```
+
+#### Sparse Fieldsets
+
+```ruby
+query = Product.munson.fields(products: [:name, :price])
+# its chainable
+query.includes(:manufacturer).fields(manufacturer: [:name])
+
+query.to_params
+#=> {:fields=>{:products=>"name,price", :manufacturer=>"name"}, :include=>"manufacturer"}
+
+query.fetch #=> Some lovely data
+```
+
+#### All the things!
+```ruby
+query = Product.munson.
+  filter(min_price: 30, max_price: 65).
+  includes(:manufacturer).
+  sort(popularity: :desc, price: :asc).
+  fields(product: ['name', 'price'], manufacturer: ['name', 'website']).
+  page(number: 1, limit: 100)
+
+query.to_params
+#=> {:filter=>{:min_price=>"30", :max_price=>"65"}, :fields=>{:product=>"name,price", :manufacturer=>"name,website"}, :include=>"manufacturer", :sort=>"-popularity,price", :page=>{:limit=>10}}
+
+query.fetch #=> Some lovely data
+```
+
+#### Fetching a single resource
+
+```ruby
+Product.munson.find(1)
+```
+
+#### Paginating
+
+A paged and offset paginator are included with Munson.
+
+Using the ```offset``` paginator
+```ruby
+class Product
+  def self.munson
+    return @munson if @munson
+    @munson = Munson::Agent.new(
+      paginator: :offset,
+      path: 'products'
+    )
+  end
+end
+
+query = Product.munson.includes('manufacturer').page(offset: 10, limit: 25)
+query.to_params
+# => {:include=>"manufacturer", :page=>{:limit=>10, :offset=>10}}
+
+query.fetch #=> Some lovely data
+```
+
+Using the ```paged``` paginator
+```ruby
+class Product  
+  def self.munson
+    return @munson if @munson
+    @munson = Munson::Agent.new(
+      paginator: :paged,
+      path: 'products'
+    )
+  end
+end
+
+query = Product.munson.includes('manufacturer').page(page: 10, size: 25)
+query.to_params
+# => {:include=>"manufacturer", :page=>{:page=>10, :size=>10}}
+
+query.fetch #=> Some lovely data
+```
+
+##### Custom paginators
+Since the JSON API Spec does not dictate [how to paginate](http://jsonapi.org/format/#fetching-pagination), Munson has been designed to make adding custom paginators pretty easy.
+
+```ruby
+class CustomPaginator
+  # @param [Hash] Hash of options like max/default page size
+  def initialize(opts={})
+  end
+
+  # @param [Hash] Hash to set the 'limit' and 'offset' to be returned later by #to_params
+  def set(params={})
+  end
+
+  # @return [Hash] Params to be merged into query builder.
+  def to_params
+    { page: {} }
+  end
+end
+
+```
+
+### Munson::Resource
+
+A munson resource provides a DSL in the including class for doing common JSON API queries on your ruby class.
+
+It delegates a set of methods so that they dont have to be accessed through the ```munson``` class method and sets a few options based on the including class name.
+
+It also will alter the response objects coming from #fetch and #find. Instead of returning a json hash like
+when using the bare Munson::Agent, Munson::Resource will pass the JSON Spec attributes and the ID as a hash into your class's initializer.
+
+```ruby
+class Product
+  include Munson::Resource
+end
+
+# Munson method is there, should you be looking for it.
+Product.munson #=> Munson::Agent
+```
+
+Changing the type name:
+```ruby
+class Product
+  include Munson::Resource
+  munson.type = "things"
+end
+```
+
+#### Filtering
+
+```ruby
+query = Product.filter(min_price: 30, max_price: 65)
+# its chainable
+query.filter(category: 'Hats').filter(size: ['small', 'medium'])
+
+query.to_params
+#=> {:filter=>{:min_price=>"30", :max_price=>"65", :category=>"Hats", :size=>"small,medium"}}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+#### Sorting
+
+```ruby
+query = Product.sort(created_at: :desc)
+# its chainable
+query.sort(:price) # defaults to ASC
+
+query.to_params
+#=> {:sort=>"-created_at,price"}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+#### Including (Side loading related resources)
+
+```ruby
+query = Product.includes(:manufacturer)
+# its chainable
+query.includes(:vendor)
+
+query.to_params
+#=> {:include=>"manufacturer,vendor"}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+#### Sparse Fieldsets
+
+```ruby
+query = Product.fields(products: [:name, :price])
+# its chainable
+query.includes(:manufacturer).fields(manufacturer: [:name])
+
+query.to_params
+#=> {:fields=>{:products=>"name,price", :manufacturer=>"name"}, :include=>"manufacturer"}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+#### All the things!
+```ruby
+query = Product.
+  filter(min_price: 30, max_price: 65).
+  includes(:manufacturer).
+  sort(popularity: :desc, price: :asc).
+  fields(product: ['name', 'price'], manufacturer: ['name', 'website']).
+  page(number: 1, limit: 100)
+
+query.to_params
+#=> {:filter=>{:min_price=>"30", :max_price=>"65"}, :fields=>{:product=>"name,price", :manufacturer=>"name,website"}, :include=>"manufacturer", :sort=>"-popularity,price", :page=>{:limit=>10}}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+#### Fetching a single resource
+
+```ruby
+Product.find(1) #=> product
+```
+
+#### Paginating
+
+A paged and offset paginator are included with Munson.
+
+Using the ```offset``` paginator
+```ruby
+class Product
+  include Munson::Resource
+  munson.paginator = :offset
+  munson.paginator_options = {default: 10, max: 100}
+end
+
+query = Product.includes('manufacturer').page(offset: 10, limit: 25)
+query.to_params
+# => {:include=>"manufacturer", :page=>{:limit=>10, :offset=>10}}
+
+query.fetch #=> Munson::Collection<Product,Product>
+```
+
+Using the ```paged``` paginator
+```ruby
+class Product
+  include Munson::Resource
+  munson.paginator = :paged
+  munson.paginator_options = {default: 10, max: 100}
+end
+
+query = Product.includes('manufacturer').page(page: 10, size: 25)
+query.to_params
+# => {:include=>"manufacturer", :page=>{:page=>10, :size=>10}}
+
+query.fetch #=> Some lovely data
+```
+
+## 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/coryodaniel/munson.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "munson"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/munson/agent.rb

@@ -0,0 +1,129 @@
+module Munson
+  class Agent
+    extend Forwardable
+    def_delegators :query, :includes, :sort, :filter, :fields, :fetch, :page
+
+    attr_writer :connection
+
+    attr_accessor :type
+    attr_accessor :query_builder
+
+    attr_reader :paginator
+    attr_accessor :paginator_options
+
+    # Creates a new Munson::Agent
+    #
+    # @param [Hash] opts={} describe opts={}
+    # @option opts [Munson::Connection] :connection to use
+    # @option opts [#to_s, Munson::Paginator] :paginator to use on query builder
+    # @option opts [Class] :query_builder provide a custom query builder, defaults to {Munson::QueryBuilder}
+    # @option opts [#to_s] :type JSON Spec type. Type will be added to the base path set in the Faraday::Connection
+    def initialize(opts={})
+      @connection    = opts[:connection]
+      @type          = opts[:type]
+
+      @query_builder = opts[:query_builder].is_a?(Class) ?
+        opts[:query_builder] : Munson::QueryBuilder
+
+      self.paginator     = opts[:paginator]
+      @paginator_options = opts[:paginator_options]
+    end
+
+    def paginator=(pager)
+      if pager.is_a?(Symbol)
+        @paginator = "Munson::Paginator::#{pager.to_s.classify}Paginator".constantize
+      else
+        @paginator = pager
+      end
+    end
+
+    # Munson::QueryBuilder factory
+    #
+    # @example creating a query
+    #   @agent.includes('user').sort(age: :desc)
+    #
+    # @return [Munson::QueryBuilder] a query builder
+    def query
+      if paginator
+        query_pager = paginator.new(paginator_options || {})
+        @query_builder.new paginator: query_pager, agent: self
+      else
+        @query_builder.new agent: self
+      end
+    end
+
+    # Connection that will be used for HTTP requests
+    #
+    # @return [Munson::Connection] current connection of Munson::Agent or Munson.default_connection if not set
+    def connection
+      return @connection if @connection
+      Munson.default_connection
+    end
+
+    def find(id, headers: nil, params: nil)
+      path = [type, id].join('/')
+      response = get(path: path, headers: headers, params: params)
+      ResponseMapper.new(response).resource
+    end
+
+    # JSON API Spec GET request
+    #
+    # @option [Hash,nil] params: nil query params
+    # @option [String] path: nil path to GET, defaults to Faraday::Connection url + Agent#type
+    # @option [Hash] headers: nil HTTP Headers
+    # @return [Faraday::Response]
+    def get(params: nil, path: nil, headers: nil)
+      connection.get(
+        path: (path || type),
+        params: params,
+        headers: headers
+      )
+    end
+
+    # JSON API Spec POST request
+    #
+    # @option [Hash,nil] body: {} query params
+    # @option [String] path: nil path to GET, defaults to Faraday::Connection url + Agent#type
+    # @option [Hash] headers: nil HTTP Headers
+    # @option [Type] http_method: :post describe http_method: :post
+    # @return [Faraday::Response]
+    def post(body: {}, path: nil, headers: nil, http_method: :post)
+      connection.post(
+        path: (path || type),
+        body: body,
+        headers: headers,
+        http_method: http_method
+      )
+    end
+
+    # JSON API Spec PATCH request
+    #
+    # @option [Hash,nil] body: nil query params
+    # @option [String] path: nil path to GET, defaults to Faraday::Connection url + Agent#type
+    # @option [Hash] headers: nil HTTP Headers
+    # @return [Faraday::Response]
+    def patch(body: nil, path: nil, headers: nil)
+      post(body, path: path, headers: headers, http_method: :patch)
+    end
+
+    # JSON API Spec PUT request
+    #
+    # @option [Hash,nil] body: nil query params
+    # @option [String] path: nil path to GET, defaults to Faraday::Connection url + Agent#type
+    # @option [Hash] headers: nil HTTP Headers
+    # @return [Faraday::Response]
+    def put(body: nil, path: nil, headers: nil)
+      post(body, path: path, headers: headers, http_method: :put)
+    end
+
+    # JSON API Spec DELETE request
+    #
+    # @option [Hash,nil] body: nil query params
+    # @option [String] path: nil path to GET, defaults to Faraday::Connection url + Agent#type
+    # @option [Hash] headers: nil HTTP Headers
+    # @return [Faraday::Response]
+    def delete(body: nil, path: nil, headers: nil)
+      post(body, path: path, headers: headers, http_method: :delete)
+    end
+  end
+end

data/lib/munson/collection.rb

@@ -0,0 +1,4 @@
+module Munson
+  class Collection < ::Array
+  end
+end