simple_jsonapi_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48b579116cf787a39e4a97030ad4961063c4db940ec2fbdee03353ae162d2b6b
+  data.tar.gz: 26ae2466b469d541e2ce3105db766fbcb4dc72c80d6ba49a284a2b8a432e2341
+SHA512:
+  metadata.gz: 82279b13b63ae34daec3f2e72118108bf345d847a790e064aca6471b42bbb303d899d29cbafc76930c2738418835a69d4c918a119474d53b00ce06159b43c108
+  data.tar.gz: 1725ec376ef0e45f8e3a7bc59b59e473a516b047db2d061c5a469330e382eb18996464db771698c59a8cacd7ac21656f6252f1b753f0f5509b1312a8835a8f3c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: required
+language: ruby
+services:
+  - docker
+before_install:
+  - bin/setup
+script:
+  - rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arielmcaplan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.3.1
+RUN apt-get update -qq
+RUN gem update bundler
+RUN mkdir /simple_jsonapi_client
+WORKDIR /simple_jsonapi_client
+ADD Gemfile /simple_jsonapi_client/Gemfile
+ADD simple_jsonapi_client.gemspec /simple_jsonapi_client/simple_jsonapi_client.gemspec
+ADD . /simple_jsonapi_client
+RUN bundle install

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_jsonapi_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ariel Caplan
+
+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,264 @@
+[![Build Status](https://travis-ci.org/amcaplan/simple_jsonapi_client.svg?branch=master)](https://travis-ci.org/amcaplan/simple_jsonapi_client)
+
+# What is `SimpleJSONAPIClient`?
+
+`SimpleJSONAPIClient` is a framework for building Ruby clients for JSONAPI-compliant services.  
+
+# How do I use `SimpleJSONAPIClient`?
+
+## Setup
+
+First create models inheriting from `SimpleJSONAPIClient::Base`, and specifying a few details.
+
+* `COLLECTION_URL` - the path to fetch the resource collection
+* `INDIVIDUAL_URL` - the path to fetch an individual resource
+* `TYPE` - the JSONAPI resource type to use when creating a new resource
+* `attributes` - the names of attributes which can be found on the resource
+* relationships - `has_one` and `has_many` define relationships, and take these arguments:
+  * relationship name (e.g., the `:goats` in `has_many :goats`)
+  * `class_name` to use when instantiating related objects
+
+They should look like this:
+
+```ruby
+class Post < SimpleJSONAPIClient::Base
+  COLLECTION_URL = '/posts'
+  INDIVIDUAL_URL = '/posts/%{id}'
+  TYPE = 'posts'
+
+  attributes :title, :text
+  meta :copyright
+
+  has_one :author, class_name: 'Author'
+  has_many :comments, class_name: 'Comment'
+end
+
+class Author < SimpleJSONAPIClient::Base
+  COLLECTION_URL = '/authors'
+  INDIVIDUAL_URL = '/authors/%{id}'
+  TYPE = 'authors'
+
+  attributes :name
+
+  has_many :posts, class_name: 'Post'
+  has_many :comments, class_name: 'Comment'
+end
+
+class Comment < SimpleJSONAPIClient::Base
+  COLLECTION_URL = '/comments'
+  INDIVIDUAL_URL = '/comments/%{id}'
+  TYPE = 'comments'
+
+  attributes :text
+
+  has_one :post, class_name: 'Post'
+  has_one :author, class_name: 'Author'
+end
+```
+
+If you have behavior you'd like to share across models, you may want to first create an abstract class inheriting from `SimpleJSONAPIClient::Base` and then have all your models inherit from that.
+
+Next, create a [`Faraday`](https://github.com/lostisland/faraday) connection to handle the domain, authorization strategy, and anything else you need (making sure to include [JSON parsing middleware](https://github.com/lostisland/faraday_middleware/wiki/Parsing-responses)):
+
+```ruby
+def connection(token)
+  default_headers = {
+    'Accept' => 'application/vnd.api+json',
+    'Content-Type' => 'application/vnd.api+json',
+    'Authorization' => "token=#{token}"
+  }
+
+  @connection ||= Faraday.new(url: 'https://example.com', headers: default_headers) do |connection|
+    connection.request :json
+    connection.response :json, :content_type => /\bjson$/ # use middleware to parse JSON when response Content-Type is json
+    connection.adapter :net_http
+  end
+end
+```
+
+Now you can start making requests!
+
+## Fetching
+
+### Laziness and `SimpleJSONAPIClient`
+
+```ruby
+Post.fetch_all(connection: connection)
+=> #<Enumerator: #<Enumerator::Generator:0x00562894acd420>:each>
+```
+
+What's going on?  `SimpleJSONAPIClient` tries to be as lazy as possible while still being convenient.  So if you actually want to fetch everything, you'll be able to call `Array` methods and it will fetch the resource, paginating through all the results.  If it's an endpoint with thousands of pages, you can use `Enumerator` methods like `#each` and it'll paginate through the results, fetching the next page when it runs out of objects.
+
+Let's call `#to_a` to see a bit more detail.
+
+```ruby
+posts = Post.fetch_all(connection: connection).to_a
+=> [#<Post id=1 title="A Very Proper Post Title" text="I am absolutely incensed about something." author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>,
+ #<Post id=2 title="The System is Down" text="The Cheat" author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/2/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/2/comments>>]
+```
+
+Attributes are loaded immediately, but relationships are lazily instantiated.  So if we dig a little bit further:
+
+```ruby
+posts.first.author
+=> #<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author>
+```
+
+Nope, still lazy!  However, once we start fetching details about the author, `SimpleJSONAPIClient` knows a request has to be made, and fills in the details:
+
+```ruby
+posts.first.author.id
+=> "3"
+
+posts.first.author
+=> #<Author id=3 name="Filbert" posts=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Post url=http://jsonapi_app:3000/authors/3/posts> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/authors/3/comments>>
+```
+
+We can read more easily by calling `#as_json`:
+
+```ruby
+posts.first.author.as_json
+=> {
+  :data => {
+    :type => "authors",
+    :attributes => { :name => "Filbert" },
+    :relationships => {
+      :posts => {
+        :data => [{ :type => "posts", :id => "1" }]
+      },
+      :comments => { :data => [] }
+    }
+  }
+}
+```
+
+### More About Fetching Capabilities
+
+You can also explicitly fetch a single item:
+
+```ruby
+post = Post.fetch(connection: connection, url_opts: { id: 1 })
+=> #<Post id=1 title="A Very Proper Post Title" text="I am absolutely incensed about something." author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+```
+
+`url_opts`, in all cases where you see them, are passed to the template Strings for `INDIVIDUAL_URL` and `COLLECTION_URL` in the model.
+
+You've already seen that `id` and `relationships` are available; `attributes` and `meta` information also become methods on the object:
+
+```ruby
+post = Post.fetch(connection: connection, url_opts: { id: 1 })
+post.title
+=> "A Very Proper Post Title"
+post.text
+=> "I am absolutely incensed about something."
+post.copyright
+=> "Copyright 2017"
+```
+
+You can also use JSONAPI includes to reduce the number of requests that are necessary:
+
+```ruby
+post = JSONAPIAppClient::Post.fetch(connection: connection, url_opts: { id: 1 }, includes: ['author', 'comments.author'])
+post.author # will not make another web request
+post.comments.first.author # will not make another web request
+```
+
+`SimpleJSONAPIClient` will check the included records for related records you access through the returned model.
+
+And finally, you can use JSONAPI-style filtering as well:
+
+```ruby
+JSONAPIAppClient::Author.fetch_all(connection: connection, filter_opts: { name: 'Filbert' }).to_a
+=> [#<JSONAPIAppClient::Author id=1 name="Filbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/1/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/1/comments>>]
+```
+
+## Creating
+
+Creating records is available from the model class:
+
+```ruby
+post = Post.fetch(url_opts: { id: 1 }, connection: connection)
+=> #<Post id=1 title="A Very Proper Post Title" text="I am absolutely incensed about something." author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+author = Author.fetch(url_opts: { id: 1}, connection: connection)
+=> #<Author id=1 name="Filbert" posts=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Post url=http://jsonapi_app:3000/authors/1/posts> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/authors/1/comments>>
+
+Comment.create(connection: connection, text: 'I adore your article!', post: post, author: author)
+=> #<Comment id=19 text="I adore your article!" post=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Client::Post url=http://jsonapi_app:3000/comments/19/post> author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/comments/19/author>>
+```
+
+The created record is returned; if creation fails, a `SimpleJSONAPIClient::Errors::ApiError` is raised.
+
+## Updating
+
+If you want to update a record, you can do it from the model itself:
+
+```ruby
+post = Post.fetch(url_opts: { id: 1 }, connection: connection)
+=> #<Post id=1 title="A Very Proper Post Title" text="I am absolutely incensed about something." author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+[2] pry(main)> post.update(attributes: { text: 'foo' })
+=> #<Post id=1 title="A Very Proper Post Title" text="foo" author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+```
+
+If you have the ID of the record handy, you update straight from the model class without fetching the record first:
+
+```ruby
+Post.update(id: 1, url_opts: { id: 1 }, connection: connection, text: 'foo')
+=> #<Post id=1 title="A Very Proper Post Title" text="foo" author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+```
+
+## Deleting
+
+You can delete a record from the model itself:
+
+```ruby
+post = Post.fetch(url_opts: { id: 1 }, connection: connection)
+=> #<Post id=1 title="A Very Proper Post Title" text="I am absolutely incensed about something." author=#<SimpleJSONAPIClient::Base::SingularLinkRelationship model_class=Author url=http://jsonapi_app:3000/posts/1/author> comments=#<SimpleJSONAPIClient::Base::ArrayLinkRelationship model_class=Comment url=http://jsonapi_app:3000/posts/1/comments>>
+
+post.delete
+=> true
+Post.fetch(url_opts: { id: 1 }, connection: connection)
+=> nil
+```
+
+or from the class, if you have the ID:
+
+```ruby
+Post.delete(url_opts: { id: 1 }, connection: connection)
+=> true
+Post.fetch(url_opts: { id: 1 }, connection: connection)
+=> nil
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_jsonapi_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_jsonapi_client
+
+## Development
+
+You must have [Docker](https://docker.com) and [Docker Compose](https://docs.docker.com/compose/) installed to run the tests and use the built-in development utilities.
+
+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, and `bin/rails` to interact with the Rails app in `spec/jsonapi_app` that is provided for local development and testing.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amcaplan/simple_jsonapi_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleJsonapiClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amcaplan/simple_jsonapi_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :spec do
+  exec('docker-compose run spec')
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker-compose run console

data/bin/development_start

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_jsonapi_client"
+require "./spec/jsonapi_app_client"
+
+# 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