uri_service-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb3aaec6e73b78430f7bd3a1755d1e63d1d90a57
+  data.tar.gz: ae641aa76758fdce2f335e6dceb06581f505346f
+SHA512:
+  metadata.gz: 82f1b938cd6a7752345f347bf4cf9d64d43bda382027bd72b2f27d83fec056f3a879e42d309300e29e8015b72dd6e3028ec5d90177263eeaa5895618a583cc26
+  data.tar.gz: 533a498d4c76050166aa22c1ea52958c8d2d0201637c1e52b7fe5bf02511f4a466afbb82f44e08e3a2a0143c8d8343f6a9b9f92f0108fb018a73cacb62615b1e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+Naming/FileName:
+  Exclude:
+    - '*.gemspec'
+    - 'Gemfile'
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining

data/.travis.yml

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

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 uri_service-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    uri_service-client (0.1.0)
+      faraday (~> 0.15.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    bixby (1.0.0)
+      rubocop (~> 0.50, <= 0.52.1)
+      rubocop-rspec (~> 1.22, <= 1.22.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.8)
+    json (2.1.0)
+    multipart-post (2.0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.22.2)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.20.2)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bixby (~> 1.0.0)
+  bundler (~> 1.16)
+  coveralls
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  uri_service-client!
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,59 @@
+# UriService::Client
+[![Build Status](https://travis-ci.org/cul/uri_service-client.svg?branch=master)](https://travis-ci.org/cul/uri_service-client) [![Coverage Status](https://coveralls.io/repos/github/cul/uri_service-client/badge.svg?branch=master)](https://coveralls.io/github/cul/uri_service-client?branch=master)
+
+This gem is a lightweight ruby wrapper around the UriService API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uri_service-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uri_service-client
+
+## Usage
+
+### Configuring Connection
+In order to make a connection to the URI Service API a `url` and an `api_key` are required. The following shows an example on how to set the url and api_key for every request. They can also be set on a per-connection basis. This is shown in the next section.
+
+```ruby
+UriService::Client.configure do |c|
+  c.url = 'https://example.com'
+  c.api_key = 'reallysecretapikey'
+end
+```
+
+### Creating Connection
+```ruby
+# Creates connection using globally set url and api_key.
+uri_service = UriService::Client.connection
+
+# Creates connection by setting url and api_keu per connection.
+uri_service = UriService::Client.connection(url: 'https://example.com', api_key: 'reallysecretapikey')
+```
+
+### Making Requests
+
+```ruby
+uri_service = UriService::Client.connection
+uri_service.all_vocabularies
+
+```
+
+## Development
+
+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.
+
+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]/uri_service-client.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'uri_service/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
+
+require 'irb'
+IRB.start(__FILE__)

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/uri_service/client.rb

@@ -0,0 +1,23 @@
+require 'uri_service/client/version'
+require 'uri_service/client/connection'
+
+module UriService
+  module Client
+    class << self
+      attr_accessor :url, :api_key
+
+      def connection(options = {})
+        UriService::Client::Connection.new(options)
+      end
+
+      def configure
+        yield self
+      end
+
+      def reset!
+        @url = nil
+        @api_key = nil
+      end
+    end
+  end
+end

data/lib/uri_service/client/connection.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'uri_service/client/error'
+require 'uri_service/client/form_fields'
+require 'uri_service/client/requests/custom_fields'
+require 'uri_service/client/requests/terms'
+require 'uri_service/client/requests/vocabularies'
+
+module UriService
+  module Client
+    class Connection
+      include UriService::Client::Requests::Terms
+      include UriService::Client::Requests::Vocabularies
+      include UriService::Client::Requests::CustomFields
+
+      attr_reader :connection, :url, :api_key
+
+      BASE_PATH = '/api/v1'.freeze
+      JSON_MIME = 'application/json'.freeze
+
+      def initialize(options = {})
+        config(options)
+
+        @connection = Faraday.new(url: url) do |conn|
+          conn.request    :url_encoded # form-encode POST params
+          conn.token_auth api_key
+
+          # Must be the last middleware, must be set.
+          conn.adapter    Faraday.default_adapter
+        end
+      end
+
+      def request(method, path, body: {}, params: {})
+        response = connection.send(method, "#{BASE_PATH}#{path}") do |r|
+          r.headers['Accept'] = JSON_MIME
+
+          unless body.nil? || body.empty?
+            r.body = body.to_json
+            r.headers['Content-Type'] = JSON_MIME
+          end
+
+          params.each { |k, v| r.params[k] = v }
+        end
+
+        UriService::Client::Response.new(response)
+      rescue StandardError
+        raise UriService::Client::Error
+      end
+
+      def form_fields
+        response = request(:get, '/open_api_specification')
+        UriService::Client::FormFields.new(response)
+      rescue StandardError
+        raise UriService::Client::Error
+      end
+
+      private
+
+        def config(options = {})
+          [:url, :api_key].each do |f|
+            instance_variable_set("@#{f}", options[f] || UriService::Client.send(f))
+
+            raise UriService::Client::ConfigurationError, "Missing UriService::Client.#{f}" if send(f).nil? || send(f).empty?
+          end
+        end
+    end
+  end
+end

data/lib/uri_service/client/error.rb

@@ -0,0 +1,6 @@
+module UriService
+  module Client
+    class Error < StandardError; end
+    class ConfigurationError < Error; end
+  end
+end

data/lib/uri_service/client/form_fields.rb

@@ -0,0 +1,64 @@
+module UriService
+  module Client
+    class FormFields
+      attr_reader :specification
+
+      def initialize(response)
+        @specification = response.data
+      end
+
+      def vocabulary(action)
+        case action.to_s
+        when 'index'
+          params_for('/vocabularies', 'get')
+        when 'show'
+          params_for('/vocabularies/{string_key}', 'get')
+        when 'create'
+          params_for('/vocabularies', 'post')
+        when 'update'
+          params_for('/vocabularies/{string_key}', 'patch')
+        when 'delete'
+          params_for('/vocabularies/{string_key}', 'delete')
+        end
+      end
+
+      def custom_fields(action)
+        case action.to_s
+        when 'create'
+          params_for('/vocabularies/{string_key}/custom_fields', 'post')
+        when 'update'
+          params_for(
+            '/vocabularies/{string_key}/custom_fields/{field_key}',
+            'patch'
+          )
+        when 'delete'
+          params_for('/vocabularies/{string_key}/custom_fields/{field_key}',
+                     'delete')
+        end
+      end
+
+      def term(vocabulary, action)
+        case action.to_s
+        when 'index'
+          params_for("/vocabularies/#{vocabulary}/terms", 'get')
+        when 'show'
+          params_for("/vocabularies/#{vocabulary}/terms/{uri}", 'get')
+        when 'create'
+          params_for("/vocabularies/#{vocabulary}/terms", 'post')
+        when 'update'
+          params_for("/vocabularies/#{vocabulary}/terms/{uri}", 'patch')
+        when 'delete'
+          params_for("/vocabularies/#{vocabulary}/terms/{uri}", 'delete')
+        end
+      end
+
+      private
+
+        def params_for(path, action)
+          @specification['paths'][path][action]['parameters'].keep_if do |h|
+            h.key?('in') && h['in'] == 'query'
+          end
+        end
+    end
+  end
+end

data/lib/uri_service/client/requests/custom_fields.rb

@@ -0,0 +1,26 @@
+module UriService
+  module Client
+    module Requests
+      module CustomFields
+        def create_custom_field(vocabulary, custom_field = {})
+          request(:post,
+                  "/vocabularies/#{vocabulary}/custom_fields",
+                  body: custom_field)
+        end
+
+        def update_custom_field(vocabulary, custom_field = {})
+          field_key = custom_field.delete('field_key') || custom_field.delete(:field_key)
+
+          request(:patch,
+                  "/vocabularies/#{vocabulary}/custom_fields/#{field_key}",
+                  body: custom_field)
+        end
+
+        def delete_custom_field(vocabulary, field_key)
+          request(:delete,
+                  "/vocabularies/#{vocabulary}/custom_fields/#{field_key}")
+        end
+      end
+    end
+  end
+end

data/lib/uri_service/client/requests/terms.rb

@@ -0,0 +1,37 @@
+require 'uri_service/client/response'
+
+module UriService
+  module Client
+    module Requests
+      module Terms
+        def term(vocabulary, uri)
+          uri = CGI.escape(uri)
+          request(:get, "/vocabularies/#{vocabulary}/terms/#{uri}")
+        end
+
+        def create_term(vocabulary, term = {})
+          request(:post, "/vocabularies/#{vocabulary}/terms", body: term)
+        end
+
+        def update_term(vocabulary, term = {})
+          uri = term.delete('uri') || term.delete(:uri)
+          request(:patch,
+                  "/vocabularies/#{vocabulary}/terms/#{CGI.escape(uri)}",
+                  body: term)
+        end
+
+        def delete_term(vocabulary, uri)
+          uri = CGI.escape(uri)
+          request(:delete, "/vocabularies/#{vocabulary}/terms/#{uri}")
+        end
+
+        def search_terms(vocabulary, search_params = {})
+          request(:get,
+                  "/vocabularies/#{vocabulary}/terms",
+                  params: search_params)
+        end
+        alias terms search_terms
+      end
+    end
+  end
+end

data/lib/uri_service/client/requests/vocabularies.rb

@@ -0,0 +1,28 @@
+module UriService
+  module Client
+    module Requests
+      module Vocabularies
+        def vocabularies(params = {})
+          request(:get, '/vocabularies', params: params)
+        end
+
+        def vocabulary(string_key)
+          request(:get, "/vocabularies/#{string_key}")
+        end
+
+        def create_vocabulary(vocabulary = {})
+          request(:post, '/vocabularies', body: vocabulary)
+        end
+
+        def update_vocabulary(vocabulary = {})
+          string_key = vocabulary.delete(:string_key) || vocabulary.delete('string_key')
+          request(:patch, "/vocabularies/#{string_key}", body: vocabulary)
+        end
+
+        def delete_vocabulary(string_key)
+          request(:delete, "/vocabularies/#{string_key}")
+        end
+      end
+    end
+  end
+end

data/lib/uri_service/client/response.rb

@@ -0,0 +1,20 @@
+require 'json'
+
+module UriService
+  module Client
+    class Response
+      attr_reader :raw, :data, :status
+
+      def initialize(response)
+        @status = response.status
+        @raw = response.body
+        @data = raw.nil? || raw.empty? ? nil : JSON.parse(raw)
+      end
+
+      # Checks if errors are present in the response
+      def errors?
+        data.key?('errors') # and check status
+      end
+    end
+  end
+end

data/lib/uri_service/client/version.rb

@@ -0,0 +1,5 @@
+module UriService
+  module Client
+    VERSION = '0.1.0'.freeze
+  end
+end

data/uri_service-client.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uri_service/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uri_service-client'
+  spec.version       = UriService::Client::VERSION
+  spec.authors       = ['Carla Galarza']
+  spec.email         = ['cmg2228@columbia.edu']
+  spec.summary       = 'Uri Service Client'
+  spec.description   = 'Simple Ruby wrapper around the UriService API.'
+  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_runtime_dependency 'faraday', '~> 0.15.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bixby', '~> 1.0.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: uri_service-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carla Galarza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Simple Ruby wrapper around the UriService API.
+email:
+- cmg2228@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uri_service/client.rb
+- lib/uri_service/client/connection.rb
+- lib/uri_service/client/error.rb
+- lib/uri_service/client/form_fields.rb
+- lib/uri_service/client/requests/custom_fields.rb
+- lib/uri_service/client/requests/terms.rb
+- lib/uri_service/client/requests/vocabularies.rb
+- lib/uri_service/client/response.rb
+- lib/uri_service/client/version.rb
+- uri_service-client.gemspec
+homepage: 
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Uri Service Client
+test_files: []