api_navigator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 524678c0c11ba690fca89e18aeadd0f78bf5971aee1894932330c57d6a2504ae
+  data.tar.gz: 4c5a52483b9f8a427a2fbe0395c6fcc1afe58892771ecf37c9a35f3924baddc6
+SHA512:
+  metadata.gz: c256f751653e5744d6e8a8d9a06c9138bf243b6a506971ea82792afe801d9234c5a15037a342005527ff0a522dd3ec0ffe4fa85142249f302bdf12a9b7f5ddf4
+  data.tar.gz: 939e6a10298963f490eee05c1fcdd04f5f0220208d32d076033920a1ae693b88f2d8d6c8dd4af508e4c6daeeca47f0097cd841168d1c090a0efd87a2d9f0d8a7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+examples/william.rb
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+api_navigator

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+sudo: false
+
+matrix:
+  include:
+    - rvm: 2.4.1
+    - rvm: 2.4.1
+      script:
+        - bundle exec danger
+    - rvm: jruby-9.1.12.0
+    - rvm: jruby-head
+    - rvm: 2.2.7
+    - rvm: 2.3.4
+    - rvm: rbx-2
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+bundler_args: --without development

data/.yardopts

@@ -0,0 +1,8 @@
+--title "ApiNavigator"
+--readme README.md
+--protected
+--private
+--plugin tomdoc
+lib 
+-
+[A-Z]*.*

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (August 1, 2018)
+
+* Initial public release - [@verticnaut](https://github.com/verticonaut).

data/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+Contributing to ApiNavigator
+============================
+
+TODO…

data/Dangerfile

@@ -0,0 +1,2 @@
+changelog.check
+toc.check

data/Gemfile

@@ -0,0 +1,23 @@
+# NOTE: this is temporary until Bundler 2.0 changes how github: references work.
+git_source(:github) { |repo| "https://github.com/#{repo['/'] ? repo : "#{repo}/#{repo}"}.git" }
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug', '~> 3.4'
+  gem 'rake'
+  gem 'rubocop', '~> 0.50.0', require: false
+  gem 'simplecov', require: false
+  gem 'rspec', '~> 3.7'
+  gem 'guard-rspec'
+  gem 'factory_bot_rails'
+  gem 'faker'
+end
+
+group :test do
+  gem 'turn'
+  gem 'webmock'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2018 Oriol Gual, Codegram Technologies and Contributors
+
+MIT License
+
+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,5 @@
+# ApiNavigator
+
+Inspired by Hyperclient from [https://github.com/codegram/hyperclient](https://github.com/codegram/hyperclient)
+
+Copied and adapted to own JSON-Format WIP

data/RELEASING.md

@@ -0,0 +1,4 @@
+Releasing ApiNavigator
+======================
+
+TODO…

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/test/'
+    add_filter '/features/'
+  end
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = true
+end
+
+desc 'runs the whole spinach suite'
+task :spinach do
+  ruby '-S spinach'
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[test spinach rubocop]

data/UPGRADING.md

@@ -0,0 +1,4 @@
+Upgrading ApiNavigator
+======================
+
+TODO…

data/api_navigator.gemspec

@@ -0,0 +1,23 @@
+
+require File.expand_path('../lib/api_navigator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Martin Schweizer']
+  gem.email         = ['martin@verticonaut.me']
+  gem.description   = 'ApiNavigator base on api_navigator from Oriol Gual'
+  gem.summary       = ''
+  gem.homepage      = 'https://github.com/verticonaut/api_navigator/'
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- rspec/*`.split("\n")
+  gem.name          = 'api_navigator'
+  gem.require_paths = ['lib']
+  gem.version       = ApiNavigator::VERSION
+
+  gem.add_dependency 'faraday', '>= 0.9.0'
+  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'faraday_hal_middleware'
+  gem.add_dependency 'uri_template'
+  gem.add_dependency 'net-http-digest_auth'
+  gem.add_dependency 'faraday-digestauth'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "irb/completion"
+require "api_navigator"
+
+# 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"
+
+Dir['spec/fixtures/**/*.*'].each { |f| puts f: f; require_relative "../#{f}" }
+
+Pry.start

data/bin/setup

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

data/fixtures_2.rb

@@ -0,0 +1,253 @@
+require 'json'
+
+module Spinach
+  module Fixtures2
+
+    def root_response
+      '{
+          "_links": {
+              "self": { "href": "/" },
+              "posts": { "href": "/posts" },
+              "search": { "href": "/search{?q}", "templated": true },
+              "tagged": { "href": "/search{?tags*}", "templated": true },
+              "api:authors": { "href": "/authors" },
+              "next": { "href": "/page2" }
+          }
+      }'
+    end
+
+    # collection resource 
+    def posts_response
+      response = {
+        data: [
+          {
+            data: {
+              title: 'Book 1',
+              body: 'Book 1 Body',
+              year: 1999,
+              publisher: {
+                data: {
+                  name: 'Manning Publisher',
+                },
+                _links: {
+                  self: {
+                    href: "http://localhost:3000/sample/publisher/1",
+                  }
+                },
+                _meta: { type: "publisher" }                              
+              },
+            },
+            _links: {
+              self: {
+                href: "http://localhost:3000/sample/books/1",
+              },
+              authors: {
+                href: "http://localhost:3000/sample/book/1/authors",
+              },
+              publisher: {
+                href: "http://localhost:3000/sample/book/1/publisher",
+              },
+            },
+            _meta: { type: "book" }                              
+          },
+          {
+            data: {
+              title: 'Book 2',
+              body: 'Book 2 Body',
+              year: 1999,
+              publisher: {
+                data: {
+                  name: 'PragBook Publisher',
+                },
+                _links: {
+                  self: {
+                    href: "http://localhost:3000/sample/publisher/2",
+                  }
+                },
+                _meta: { type: "publisher" }                              
+              },
+            },
+            _links: {
+              self: {
+                href: "http://localhost:3000/sample/books/2",
+              },
+              authors: {
+                href: "http://localhost:3000/sample/book/2/authors",
+              },
+              publisher: {
+                href: "http://localhost:3000/sample/book/2/publisher",
+              },
+            },
+            _meta: { type: "book" }                              
+          },
+        ],
+        _links: {
+          self: {
+            href: "http://localhost:3000/sample/books",
+          }
+        },
+        _meta: { total_number_of: 22 }
+      }
+
+      response
+    end
+
+    # singular resource
+    def post_response
+      response = {
+        data: {
+          title: 'Book 1',
+          body: 'Book 1 Body',
+          year: 1999,
+          publisher: {
+            data: {
+              name: 'Manning Publisher',
+            },
+            _links: {
+              self: {
+                href: "http://localhost:3000/sample/publisher/1",
+              }
+            },
+            _meta: { type: "book" }                              
+          },
+        },
+        _links: {
+          self: {
+            href: "http://localhost:3000/sample/books/1",
+          },
+          authors: {
+            href: "http://localhost:3000/sample/book/1/authors",
+          },
+          publisher: {
+            href: "http://localhost:3000/sample/book/1/publisher",
+          },
+        },
+        _meta: { type: "book" }                              
+      }
+
+      response
+    end
+
+  end
+end
+
+__END__
+# singular resource - nested
+{
+  data: {
+    attr1: 'ffg1',
+    attr2: 'ffg2',
+    attr3: 'ffg2',
+    attr4: 'ffg4',
+    publisher: {
+      data: { name: 'Publisher 1'},
+      _meta: {
+        type: 'publisher'
+      }
+    },
+    authors: [
+      {
+        data: {
+          name: 'Author1'
+        },
+        _links: {
+          authors: {
+            rel: 'self',
+            href: "http:…/author/1"
+          }
+        },
+        _meta: {        
+          type: 'author'
+        }
+      },
+      {
+        data: {
+          name: 'Author2'
+        },
+        _links: {
+          self: {
+            href: "http:…/author/1"
+          }
+          authors: {
+            href: "http:…/authors"
+          }
+          books: {
+            href: "http:…/author1/books"
+          }
+        },
+        _meta: {        
+          type: 'author'
+        }
+      }
+    ]
+  },
+  _links: {
+    authors: {
+      href: "http:…/authors"
+    }
+  },
+  _meta: {
+    type: 'resource_type'
+  }
+}
+
+# singular resource - nested ~/authors.json?…
+{
+  data: [
+    {
+      data: {
+        name: 'Author1'
+      },
+      _links: {
+        authors: {
+          rel: 'self',
+          href: "http:…/author/1"
+        }
+      },
+      _meta: {        
+        type: 'author'
+      }
+    },
+    {
+      data: {
+        name: 'Author2'
+      },
+      _links: {
+        authors: {
+          rel: 'self',
+          href: "http:…/author/1"
+        }
+      },
+      _meta: {        
+        type: 'author'
+      }
+    }
+  ]
+  _links: {
+    self: {
+      name: 'Authors',
+      href: "http:…/authors"
+    }
+  },
+  _meta: {
+    type: 'resource_type'
+  }
+}
+
+
+
+# js-compact
+{
+  attr1: 'ffg1',
+  attr2: 'ffg2',
+  attr3: 'ffg2',
+  attr4: 'ffg4',
+  publisher: { name: 'Publisher 1'},
+  authors: [
+    { name: 'Author1' },
+    { name: 'Author2' }
+  ]
+}
+
+
+# articles?_include="{authors: 'person'},publisher"