artemis-api_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 251b9fd8afef48a76067b72e91b28fc7f883c0980d0d9fccbc8d318a3526e1b9
+  data.tar.gz: d94e64aa94427ced062f2f9f4ace9b1c5a99959bd4080f883bd0a958276dfb51
+SHA512:
+  metadata.gz: a13498d96c834c6e7fe835e593ac07d052479fbcfb77e74f6a7a35a504d9a5d4a8fa90122bbc248409da2d32bdc463231f88e615c485bb5eba16f64ff383f09b
+  data.tar.gz: f1dc59710b594c79d896d5cc1471496f4dd22622264a7252760ab0132570abdf71f1931a1f5f8c507f46218587e164b6af7bd7fa80e79f112d6a85ed5f072dac

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,230 @@
+inherit_from: .rubocop_todo.yml
+require: rubocop-rspec
+
+# RSpec is a big DSL so ignore this in specs
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+# -----------------------------------------------------------------------------
+# Style / Layout
+# -----------------------------------------------------------------------------
+
+# All our files should be UTF-8
+Style/Encoding:
+  Enabled: true
+
+# Don't require the frozen string comment, later versions of ruby will do this by default
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Go for consitent instead of all the other wierd setups
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+# Spacing it out is more work then just letting it be, so lets let it be
+Layout/AlignArray:
+  Enabled: false
+
+# We always want key style
+Layout/AlignHash:
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle: key
+  EnforcedLastArgumentHashStyle: always_ignore
+
+# We want to go for consitency and nothing fancy really, the style is quite simple
+# just indent with 2 tabs always. This means we have to disable all the rubocops
+#
+# @example
+#   method(has: 'value',
+#     key: 'value',
+#   )
+#
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/MultilineHashBraceLayout:
+  Enabled: false
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+####
+
+# Enforces if / else / end to always use 2 identations, even when assigned
+#
+# @example
+#   variable = if cookies
+#     'eat'
+#   else
+#     'cry'
+#   end
+#
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Only require braces when there might be possible confusion on what is a hsahs and what not
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# We prefere alias_method
+# ref: http://blog.bigbinary.com/2012/01/08/alias-vs-alias-method.html
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+
+# Prefere do..end when you have more then 2 lines in a block
+Style/BlockDelimiters:
+  Enabled: true
+  EnforcedStyle: line_count_based
+
+# With rails being very picky on eager loading we disable this,
+# I also see no benefit and it really depends on the readability of the code
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Don't bitch about documentation
+Style/Documentation:
+  Enabled: false
+
+# I do see it an anti pattern but ruby just misses a boolean class imoh
+Style/DoubleNegation:
+  Enabled: false
+
+# extend self != module_function, extend self has its useful cases
+Style/ModuleFunction:
+  Enabled: false
+
+# `inject` and `reduce` can make more sense and are more readable, shorter
+# to type, for this reason I don't like to enforce this at all.
+Style/EachWithObject:
+  Enabled: false
+
+# When you have an empty method we don't want it to become a oneliner with a ;
+# That looks ugly and just reminds me of PHP days I don't want to go to
+Style/EmptyMethod:
+  Enabled: true
+  EnforcedStyle: expanded
+
+# Don't care about how we formated strings
+Style/FormatString:
+  Enabled: false
+
+# We hate hash rockets, shoot to the moon
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19
+
+# Sometimes it is more readble and easier to understand, enforcing is a step to far
+Style/GuardClause:
+  Enabled: false
+
+# We like the short lambda syntax
+Style/Lambda:
+  Enabled: true
+  EnforcedStyle: literal
+
+# I don't see an issue with having a multiline and if statement at the end
+Style/MultilineIfModifier:
+  Enabled: false
+
+# We prefere next instead of an if inside loops, exclude the 2 workers since they
+# rely on checking busy workers in sidekiq
+Style/Next:
+  Enabled: true
+
+# Those predicates are confusing, it takes longer to read a word then to pattern match
+Style/NumericPredicate:
+  Enabled: true
+  EnforcedStyle: comparison
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+# We don't care about regex printing
+Style/RegexpLiteral:
+  Enabled: false
+
+# Do not care about single or double quotes, thats just annoying
+Style/StringLiterals:
+  Enabled: false
+
+# No preference, can be handy or not but certainly dont nag about it
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+# Don't care how we use variable names with numbers
+Naming/VariableNumber:
+  Enabled: false
+
+# Allow f as a name since its just a lot for forms
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - _
+
+# Enforce different brackets when we allow interpolating
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '()'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '()'
+    '%W': '[]'
+
+# Enfirce a symbol array if you have more then 5 items in it
+Style/SymbolArray:
+  Enabled: true
+  MinSize: 5
+
+Style/WordArray:
+  Enabled: true
+  MinSize: 5
+
+# Do not place comments on the same line as certain keywords. (eg def / end)
+Style/CommentedKeyword:
+  Enabled: false
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+# Not using rails or fixtures so this can be ignored
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,48 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-02-26 12:04:46 +0100 using RuboCop version 0.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/artemis/adapters/net_http_hmac_adapter_spec.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 33
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/artemis/adapters/net_http_hmac_adapter_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/artemis/adapters/net_http_hmac_adapter_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 6
+
+# Offense count: 17
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 123

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+env:
+  - COVERALLS_RUN_LOCALLY=true
+rvm:
+  - 2.5.3
+bundler_args: --jobs=2
+before_install: gem install bundler -v 1.17.3
+
+script:
+  - bundle exec rake spec
+  - bundle exec rake rubocop

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 artemis-api-auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jan Stevens
+
+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,68 @@
+# Artemis ApiAuth
+[![Build Status](https://travis-ci.org/JanStevens/artemis-api-auth.svg?branch=master)](https://travis-ci.org/JanStevens/artemis-api-auth)
+[![Coverage Status](https://coveralls.io/repos/github/JanStevens/artemis-api-auth/badge.svg?branch=master)](https://coveralls.io/github/JanStevens/artemis-api-auth?branch=master)
+
+This gem provides a new Adapter for the [Artemis](https://github.com/yuki24/artemis) GraphQL ruby client to support HMAC Authentication
+using [ApiAuth](https://github.com/mgomes/api_auth)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'artemis-api_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install artemis-api-auth-adapter
+
+## Usage
+
+After following the installation instruction of Artemis, update your `config/graphql.yml` to use the new `net_http_hmac` adapter
+
+```yaml
+default: &default
+  # The underlying client library that actually makes an HTTP request.
+  # Available adapters are :net_http, :net_http_persistent, :curb, and :test.
+  #
+  # It is set to :net_http by default.
+  adapter: :net_http_hmac
+```
+
+You can configure ApiAuth by setting the `default_context` in your Artemis client
+
+```ruby
+class Artsy < Artemis::Client
+  # Set the default context for HMAC authentication from the secrets
+  # This will be used in our Net HTTP HMAC adapter
+  # @see {Artemis::Adapters::NetHttpHmacAdapter}
+  self.default_context = {
+    api_auth: {
+      access_id: '1',
+      secret_key: 'very-secret-hmac-api-key',
+      # optional
+      digest: 'sha256', # default since more secure
+      override_http_method: 'POST' # default: nil
+    }
+  }
+end
+```
+
+## 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/JanStevens/artemis-api-auth
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: :spec

data/artemis-api_auth.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'artemis/api_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'artemis-api_auth'
+  spec.version = Artemis::ApiAuth::VERSION
+  spec.authors = ['Jan Stevens']
+  spec.email = ['jan@playpass.be']
+
+  spec.summary = 'Net::HTTP adapter that adds Api Auth authentication for Artemis GraphQL Client'
+  spec.description = 'Net::HTTP adapter that adds Api Auth authentication for Artemis GraphQL Client'
+  spec.homepage = 'https://github.com/JanStevens/artemis-api-auth'
+  spec.license = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'api-auth', '< 3'
+  spec.add_dependency 'artemis', '< 1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'artemis/api/auth/adapter'
+
+# 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/artemis/adapters/net_http_hmac_adapter.rb

@@ -0,0 +1,45 @@
+module Artemis
+  module Adapters
+    # We overwrite execute so we can sign the request with HMAC
+    class NetHttpHmacAdapter < Artemis::Adapters::NetHttpAdapter
+      # Makes an HTTP request for GraphQL query.
+      def execute(document:, operation_name: nil, variables: {}, context: {})
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.basic_auth(uri.user, uri.password) if uri.user || uri.password
+
+        request['Accept'] = 'application/json'
+        request['Content-Type'] = 'application/json'
+        headers(context).each { |name, value| request[name] = value }
+
+        body = {}
+        body['query'] = document.to_query_string
+        body['variables'] = variables if variables.any?
+        body['operationName'] = operation_name if operation_name
+        request.body = JSON.generate(body)
+
+        # Only changes are in here
+        signed_request = api_auth_sign_request!(request, context.fetch(:api_auth))
+        response = connection.request(signed_request)
+
+        case response.code.to_i
+        when 200, 400
+          JSON.parse(response.body)
+        when 500..599
+          raise Artemis::GraphQLServerError, "Received server error status #{response.code}: #{response.body}"
+        else
+          { 'errors' => [{ 'message' => "#{response.code} #{response.message}" }] }
+        end
+      end
+
+      private
+
+      def api_auth_sign_request!(request, api_auth)
+        override_http_method = api_auth.fetch(:override_http_method, nil)
+        digest = api_auth.fetch(:digest, 'sha256')
+        ::ApiAuth.sign!(request,
+          api_auth.fetch(:access_id), api_auth.fetch(:secret_key),
+          override_http_method: override_http_method, digest: digest)
+      end
+    end
+  end
+end

data/lib/artemis/api_auth.rb

@@ -0,0 +1 @@
+require 'artemis/adapters/net_http_hmac_adapter'

data/lib/artemis/api_auth/version.rb

@@ -0,0 +1,5 @@
+module Artemis
+  module ApiAuth
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: artemis-api_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Stevens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: artemis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rack
+  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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: rubocop
+  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: rubocop-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'
+description: Net::HTTP adapter that adds Api Auth authentication for Artemis GraphQL
+  Client
+email:
+- jan@playpass.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- artemis-api_auth.gemspec
+- bin/console
+- bin/setup
+- lib/artemis/adapters/net_http_hmac_adapter.rb
+- lib/artemis/api_auth.rb
+- lib/artemis/api_auth/version.rb
+homepage: https://github.com/JanStevens/artemis-api-auth
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Net::HTTP adapter that adds Api Auth authentication for Artemis GraphQL Client
+test_files: []