dmao-jwt-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccd3141090539748b86943ccb8224a0768173b27
+  data.tar.gz: b202051d99a17900faec12d7e190a61a1de94eca
+SHA512:
+  metadata.gz: 2baf81b1d2ac3597046be690f8b08225a08d2bc682658a01dffab7d63f5ebed295cd2e2779f9bc9f3ec341e6a437d740e71002d84aa85fd7a2dddbdcf82d1be9
+  data.tar.gz: 3f1f5ecb3981f2561776562a9c01abda567064c7156d9b9956fdbc2fe70e207f7182011a8e76bbac7aa83169bb2f8b0e6403033afeeaa289e24740c4b9392ccf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in JWT-Service-API.gemspec
+gemspec

data/JWT-Service-API.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmao/jwt/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dmao-jwt-api"
+  spec.version       = DMAO::JWT::API::VERSION
+  spec.authors       = ["Stephen Robinson"]
+  spec.email         = ["library.dit@lancaster.ac.uk"]
+
+  spec.summary       = %q{Ruby wrapper around DMAO JWT Service API}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/lulibrary/DMAO-JWT-API-rb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+  spec.add_development_dependency "vcr", "~> 3.0.3"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lancaster University Library
+
+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,41 @@
+# JWT::Service::API
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/JWT/Service/API`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'JWT-Service-API'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install JWT-Service-API
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/JWT-Service-API.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "JWT/Service/API"
+
+# 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,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/lib/dmao/jwt/api/base.rb

@@ -0,0 +1,24 @@
+require 'rest-client'
+require 'dmao/jwt/api/errors/invalid_api_base_url'
+require 'dmao/jwt/api/errors/invalid_api_token'
+
+module DMAO
+  module JWT
+    module API
+
+      class Base
+
+        def self.api
+
+          raise DMAO::JWT::API::Errors::InvalidApiBaseUrl.new if DMAO::JWT::API.base_url.nil? || DMAO::JWT::API.base_url.empty?
+          raise DMAO::JWT::API::Errors::InvalidApiToken.new if DMAO::JWT::API.api_token.nil? || DMAO::JWT::API.api_token.empty?
+
+          RestClient::Resource.new(DMAO::JWT::API.base_url, headers: { content_type: :json, authorization: "Bearer #{DMAO::JWT::API.api_token}" })
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/jwt/api/configuration.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module JWT
+    module API
+
+      module Configuration
+
+        attr_accessor :base_url, :api_token
+
+        def configure
+          yield self
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/jwt/api/errors/invalid_api_base_url.rb

@@ -0,0 +1,19 @@
+module DMAO
+  module JWT
+    module API
+      module Errors
+
+        class InvalidApiBaseUrl < StandardError
+
+          def initialize(msg="Api base url is invalid, please check that DMAO::JWT::API.configure has been called.")
+
+            super(msg)
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/dmao/jwt/api/errors/invalid_api_token.rb

@@ -0,0 +1,19 @@
+module DMAO
+  module JWT
+    module API
+      module Errors
+
+        class InvalidApiToken < StandardError
+
+          def initialize(msg="Api token is invalid, please check that DMAO::JWT::API.configure has been called.")
+
+            super(msg)
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/dmao/jwt/api/errors/invalid_jwt_issuer.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module JWT
+    module API
+      module Errors
+
+        class InvalidJWTIssuer < StandardError
+
+          def initialize(msg="JWT Issuer not found at JWT Service")
+            super(msg)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/dmao/jwt/api/errors/unable_to_issue_token.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module JWT
+    module API
+      module Errors
+
+        class UnableToIssueToken < StandardError
+
+          def initialize()
+            super
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/dmao/jwt/api/token_issuer.rb

@@ -0,0 +1,49 @@
+require 'rest-client'
+require 'json'
+require 'dmao/jwt/api/base'
+require 'dmao/jwt/api/errors/invalid_jwt_issuer'
+require 'dmao/jwt/api/errors/unable_to_issue_token'
+
+module DMAO
+  module JWT
+    module API
+
+      class TokenIssuer
+
+        def initialize issuer_name
+          @issuer_name = issuer_name
+        end
+
+        def request_token subject, institution_id, roles
+
+          if @issuer_name.nil? || @issuer_name.empty?
+            raise DMAO::JWT::API::Errors::InvalidJWTIssuer.new("JWT Issuer not set for token generator")
+          end
+
+          custom_claims = {
+              institution_id: institution_id,
+              roles: roles
+          }
+
+          request_attributes = {
+              subject: subject,
+              custom_claims: custom_claims
+          }
+
+          begin
+            response = DMAO::JWT::API::Base.api["#{@issuer_name}/tokens"].post request_attributes.to_json
+          rescue RestClient::NotFound
+            raise DMAO::JWT::API::Errors::InvalidJWTIssuer
+          rescue RestClient::UnprocessableEntity, RestClient::InternalServerError
+            raise DMAO::JWT::API::Errors::UnableToIssueToken
+          end
+
+          JSON.parse(response.body)["token"]
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/jwt/api/version.rb

@@ -0,0 +1,7 @@
+module DMAO
+  module JWT
+    module API
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/dmao_jwt_api.rb

@@ -0,0 +1,16 @@
+require 'dmao/jwt/api/version'
+require 'dmao/jwt/api/configuration'
+require 'dmao/jwt/api/base'
+require 'dmao/jwt/api/token_issuer'
+
+module DMAO
+  module JWT
+    module API
+
+      class << self
+        include Configuration
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: dmao-jwt-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Robinson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: ''
+email:
+- library.dit@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- JWT-Service-API.gemspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/dmao/jwt/api/base.rb
+- lib/dmao/jwt/api/configuration.rb
+- lib/dmao/jwt/api/errors/invalid_api_base_url.rb
+- lib/dmao/jwt/api/errors/invalid_api_token.rb
+- lib/dmao/jwt/api/errors/invalid_jwt_issuer.rb
+- lib/dmao/jwt/api/errors/unable_to_issue_token.rb
+- lib/dmao/jwt/api/token_issuer.rb
+- lib/dmao/jwt/api/version.rb
+- lib/dmao_jwt_api.rb
+homepage: https://github.com/lulibrary/DMAO-JWT-API-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around DMAO JWT Service API
+test_files: []