subjoin 0.2.1

data/spec/responses/links.json

@@ -0,0 +1,9 @@
+{
+  "self": "http://example.com/posts",
+  "related": {
+    "href": "http://example.com/articles/1/comments",
+    "meta": {
+      "count": 10
+    }
+  }
+}

data/spec/responses/meta.json

@@ -0,0 +1,13 @@
+{
+  "meta": {
+    "copyright": "Copyright 2015 Example Corp.",
+    "authors": [
+      "Yehuda Katz",
+      "Steve Klabnik",
+      "Dan Gebhardt",
+      "Tyler Kellen"
+    ]
+  },
+  "data": {}
+}
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "subjoin"
+
+cwd = File.dirname(__FILE__)
+
+ERR404 = IO.read(File.join(cwd, "responses", "404.json"))
+ARTICLE = IO.read(File.join(cwd, "responses", "article_example.json"))
+COMPOUND = IO.read(File.join(cwd, "responses", "compound_example.json"))
+LINKS = IO.read(File.join(cwd, "responses", "links.json"))
+META = IO.read(File.join(cwd, "responses", "meta.json"))

data/spec/subjoin_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe Subjoin do
+  describe "#get" do
+    it "should return parsed JSON" do
+      allow_any_instance_of(Faraday::Connection).
+        to receive(:get).and_return(double(Faraday::Response, :body => ARTICLE))
+      expect(Subjoin::get(URI("http://example.com/articles"))).
+        to be_an_instance_of(Hash)
+    end
+
+    it "should send the correct accept header" do
+      allow_any_instance_of(Faraday::Connection).
+        to receive(:get).
+            with(
+              URI,
+              Hash,
+              hash_including("Accept" => "application/vnd.api+json")
+            ).and_return(double(Faraday::Response, :body => ARTICLE))
+      Subjoin::get(URI("http://example.com/articles"))
+    end
+
+    context "with a hash of parameters" do
+      context "including include" do
+        before :each do
+          expect_any_instance_of(Faraday::Connection).
+            to receive(:get).
+                with(URI, hash_including("include" => "author,comments"), Hash).
+                and_return(double(Faraday::Response, :body => ARTICLE))
+        end
+        
+        context "and String for an include parameter" do
+          it "should get the URI with the parameter" do
+            Subjoin::get(URI("http://example.com/articles"),
+                         {"include" => "author,comments"})
+          end
+        end
+        
+        context "and an array of Strings for an include parameter" do
+          it "should join the array into a string" do
+            Subjoin::get(URI("http://example.com/articles"),
+                         {"include" => ["author", "comments"]})
+          end
+        end
+      end
+
+      context "including fields" do
+        before :each do
+          expect_any_instance_of(Faraday::Connection).
+            to receive(:get).
+                with(URI, hash_including("fields[article]" => "title,pagecount"), Hash).
+                and_return(double(Faraday::Response, :body => ARTICLE))
+        end
+
+        context "as Hash elements for each type" do
+          context "where the values are Strings" do
+            it "should pass them unchanged" do
+              Subjoin::get(URI("http://example.com/articles"),
+                           {
+                             "include" => ["author", "comments"],
+                             "fields[article]" => "title,pagecount"
+                           })
+            end
+          end
+
+          context "where the values are Arrays" do
+            it "should join them into a string" do
+              Subjoin::get(URI("http://example.com/articles"),
+                           {
+                             "include" => ["author", "comments"],
+                             "fields[article]" => ["title", "pagecount"]
+                           })
+            end
+          end
+        end
+
+        context "as a Hash for the whole" do
+          it "should turn the keys and values into strings" do
+              Subjoin::get(URI("http://example.com/articles"),
+                           {
+                             "include" => ["author", "comments"],
+                             "fields" => {"article" => "title,pagecount"}
+                           })
+          end
+
+          context "with the individual fields as Arrays of Strings" do
+            it "should join those values into Strings" do
+              Subjoin::get(URI("http://example.com/articles"),
+                           {
+                             "include" => ["author", "comments"],
+                             "fields" => {"article" => ["title", "pagecount"]}
+                           })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/subjoin.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subjoin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "subjoin"
+  spec.version       = Subjoin::VERSION
+  spec.authors       = ["Sean Redmond"]
+  spec.email         = ["sean.redmond@gmail.com"]
+  spec.summary       = %q{A practical wrapper for JSON-API interactions.}
+  spec.description   = %q{A practical wrapper for JSON-API interactions.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: subjoin
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Sean Redmond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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'
+description: A practical wrapper for JSON-API interactions.
+email:
+- sean.redmond@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardops"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/subjoin.rb
+- lib/subjoin/attributable.rb
+- lib/subjoin/document.rb
+- lib/subjoin/errors.rb
+- lib/subjoin/identifier.rb
+- lib/subjoin/inclusions.rb
+- lib/subjoin/inheritable.rb
+- lib/subjoin/jsonapi.rb
+- lib/subjoin/link.rb
+- lib/subjoin/linkable.rb
+- lib/subjoin/meta.rb
+- lib/subjoin/metable.rb
+- lib/subjoin/relationship.rb
+- lib/subjoin/resource.rb
+- lib/subjoin/version.rb
+- spec/document_spec.rb
+- spec/identifier_spec.rb
+- spec/inclusions_spec.rb
+- spec/inheritable_resource_spec.rb
+- spec/link_spec.rb
+- spec/meta_spec.rb
+- spec/relationship_spec.rb
+- spec/resource_spec.rb
+- spec/responses/404.json
+- spec/responses/article_example.json
+- spec/responses/compound_example.json
+- spec/responses/links.json
+- spec/responses/meta.json
+- spec/spec_helper.rb
+- spec/subjoin_spec.rb
+- subjoin.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A practical wrapper for JSON-API interactions.
+test_files:
+- spec/document_spec.rb
+- spec/identifier_spec.rb
+- spec/inclusions_spec.rb
+- spec/inheritable_resource_spec.rb
+- spec/link_spec.rb
+- spec/meta_spec.rb
+- spec/relationship_spec.rb
+- spec/resource_spec.rb
+- spec/responses/404.json
+- spec/responses/article_example.json
+- spec/responses/compound_example.json
+- spec/responses/links.json
+- spec/responses/meta.json
+- spec/spec_helper.rb
+- spec/subjoin_spec.rb
+has_rdoc: