okapi 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad64a91add6acfac31f3d8c3763b72aa971af79e
-  data.tar.gz: 3c3edf079db4719f111b1d900b05ea2bf02f69b9
+  metadata.gz: b4c67e307310800684dc4dce031fa1bf8e347c02
+  data.tar.gz: a2c5c7394da03e8911c71843319bf059a32043e3
 SHA512:
-  metadata.gz: f937dcdc8e7d69afc4262099925ac9f510b88303669de5c3a9ab592466b37e12790d96338f00b6d32e42e101cf167f3fa832f31fbcd19a2877028dc71f1ca5a8
-  data.tar.gz: 9c2e9304a97a3df38d0c2c21aa9a6c22afaf502b6df8fefa0ee59d1babd38212b378053af0392253f37decde670c9827fbab453f500cbf27e0894c3b78e530d4
+  metadata.gz: 43fe63985ed25721da900a18759a6e01afc9f499fe4a84a2b0d4d49c312d708dd0d29e67d60f108fd1792a59f3e0931a461a4645ecebef41848cd8d1862e8881
+  data.tar.gz: f843858ccd1b8a1d51d2ddb43faec1a9745b3363dcc994f6c1d9e9af80270e480993d334d2778e51a4e345d21816a1d673872cf0549bb562817bf348834643f1

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Purpose
+_Describe the purpose of the pull request. Include background information if necessary._
+
+## Approach
+_How does this change fulfill the purpose?_
+
+#### TODOS and Open Questions
+- [ ] Use GitHub checklists. When solved, check the box and explain the answer.
+
+## Learning
+_Describe the research stage. Add links to blog posts, patterns, libraries or addons used to solve this problem._
+
+## Screenshots
+_A picture is worth a thousand words. If you can get your meaning
+across with a GIF, then let's see those sweet visuals!_

data/CHANGELOG.md

@@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
+## [2.0.0] - 2018-01-16
+
+## Added
+- PR template
+
+## Changed
+- README to reflect the actual, encouraged API based on simple Restful
+  verbs.
+
+## Removed
+- `modules` method from `Okapi::Client` and `modules:index` command
+  from the CLI.
+
 ## [1.0.2] - 2017-11-01
 
 ### Changed

data/README.md

@@ -1,13 +1,54 @@
 # Okapi
-
+[![Gem Version](https://badge.fury.io/rb/okapi.svg)](https://badge.fury.io/rb/okapi)
 [![Build Status](https://travis-ci.org/thefrontside/okapi.rb.svg?branch=master)](https://travis-ci.org/thefrontside/okapi.rb)
 
+Ruby bindings and command line utility for the [Okapi][1] API gateway.
+
+## Synopsis
+
+To make calls to an Okapi gateway from Ruby, instantiate an instance
+of the `Okapi::Client` class by passing in the URL, Tenant, and
+auth_token to use for requests.
+
+``` ruby
+require 'okapi'
+okapi = Okapi::Client.new('https://okapi.frontside.io', "fs", "<MY-AUTH-TOKEN>")
+okapi.get("/_/proxy/modules") //=> [{id: 'mod-kb-ebsco'}, {id: 'mod-config'}]
+```
+
+The `okapi` client has methods corresponding to the major `REST`ful
+verbs: `okap.get`, `okapi.post`, `okapi.put`, `okapi.delete`
+
+By default, even if you provided them to the constructor, the client
+does not send tenant and auth information with the request. This is
+because the gateway will reject requests that provide this information
+when it is not needed. For example, an authorization request that
+provides an auth token will result in an error, so you don't want to
+send it.
+
+To send tenant, use the `tenant` property on the client
+to access an `Okapi::Client` that _will_ send tenant information.
+
 ``` ruby
+okapi.tentant.post('/authn/login', username: 'admin', password: 'password')
+```
+
+To send both tenant _and_ authorization information with a request,
+use the `user` property of the okapi client which will give you a
+client that _will_ send both these bits of information with the
+request:
 
-okapi = Okapi::Client.new('https://okapi.frontside.io')
-puts okapi.modules.first #=> { "id": "folio-mod-configuration", "name": "Configuration" }
+``` ruby
+okapi.user.get('/eholdings/configuration')
 ```
 
+## Command Line
+
+The okapi gem comes with a command line utility to help you easily
+interact with an Okapi gateway from your shell.
+
+![installing, configuring and using the okapi command line
+tool](okapi-command-line.gif "Okapi Command Line Demo")
 
 ## Installation
 
@@ -39,3 +80,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/thefro
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[1]: https://github.com/folio-org/okapi

data/lib/okapi.rb

@@ -16,19 +16,6 @@ module Okapi
       Settings.new(@url, @tenant, @token)
     end
 
-    def modules
-      endpoint = "#{settings.url}/_/proxy/modules"
-      open(endpoint) do |response|
-        JSON.parse(response.read)
-      end
-    end
-
-    def has_interface?(interface_name)
-      get("/_/proxy/tenants/#{settings.tenant}/interfaces/#{interface_name}") do |json|
-        json.length > 0
-      end
-    end
-
     def url
       settings.url
     end

data/lib/okapi/cli.rb

@@ -44,6 +44,12 @@ module Okapi
 
     subcommand "login", "authenticate to okapi and store credentials" do
       def model
+        # We know that we're going to use these values
+        # so go ahead and pull them so that if they aren't
+        # set, they will throw a configuration error
+        client.settings.url
+        client.settings.tenant
+
         username = console.ask("username: ")
         password = console.ask("password: ") { |q| q.echo = "*" }
         client.tenant.post("/authn/login", username: username, password: password) do |json, response|
@@ -94,12 +100,6 @@ module Okapi
       end
     end
 
-    subcommand "modules:index", "show a listing of all installed modules" do
-      def model
-        client.modules
-      end
-    end
-
     def client
       variables.load!
       anonymous = Okapi::Client.new(url, tenant, token)

data/lib/okapi/settings.rb

@@ -7,10 +7,12 @@ module Okapi
     end
     def url
       get_var!(:url, <<~EOM) do |url|
-this operation requires the url of your Okapi gateway, but it couldn't be found.
+This operation requires the url of your Okapi gateway, but it couldn't be found.
 
 You can fix this by setting either the `OKAPI_URL` environment variable, or
 using the `--url` option if you're using the command line.
+
+To store a default url, run `okapi config:set OKAPI_URL=<URL>`
 EOM
         URI(url)
       end
@@ -18,21 +20,25 @@ EOM
 
     def tenant
       get_var!(:tenant, <<~EOM)
-this operation requires a tenant id, but it couldn't be found.
+This operation requires a tenant id, but it couldn't be found.
 
 You can fix this by setting either the `OKAPI_TENANT` environment variable, or
 using the `--tenant` option if you're using the command line.
+
+To store a default tenant, run `okapi config:set OKAPI_TENANT=<TENANT>`
 EOM
     end
 
     def token
       get_var!(:token, <<~EOM)
-this operation requires you to be logged in, and already authenticated with
+This operation requires you to be logged in, and already authenticated with
 your Okapi cluster.
 
 You can fix this by obtaining an authenication token, and then using it by
 either setting the `OKAPI_TOKEN` environment variable or using the
 `--token` option from the command line.
+
+To log in with a username and password, run the command `okapi login`.
 EOM
     end
 

data/lib/okapi/version.rb

@@ -1,3 +1,3 @@
 module Okapi
-  VERSION = "1.0.2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okapi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Frontside Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -132,6 +132,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -148,6 +149,7 @@ files:
 - lib/okapi/cli/config.rb
 - lib/okapi/settings.rb
 - lib/okapi/version.rb
+- okapi-command-line.gif
 - okapi.gemspec
 homepage: https://github.com/thefrontside/okapi.rb
 licenses: