decathlon-https 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41287614f5f640bcae526dff1a5d0b15eae5b4716535f47fe0b220f5df2c68c5
+  data.tar.gz: c8a1d3163602e960ec07e1210ce800aa71e2b4e83a43d29b6c673a9c5c65a106
+SHA512:
+  metadata.gz: a152fac8b4ca677e1c74d41d9d82943f8b4abdf5362c6f79b6771afa46cbf96599939d4795d2a70e1a7fb6a59434b7bb5f403e717a3d00bf0c0fad02163d2d31
+  data.tar.gz: 79f209b79bac640ec446a9b5e4dbc9872ae7d98017448b83dd5385c496212cd11783cfa2703d4b5a0d15cac1e908ddba15c3fefda49fc3b174d38c70fe455182

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Decathlon Canada
+
+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,39 @@
+# Decathlon::HTTPS
+
+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/decathlon/https`. 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 'decathlon-https'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install decathlon-https
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/decathlon-https.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "decathlon/https"
+
+# 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/decathlon-http.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "decathlon/https"
+
+Gem::Specification.new do |spec|
+  spec.name          = "decathlon-https"
+  spec.version       = Decathlon::HTTPS::VERSION
+  spec.authors       = ["Jack Hayter"]
+  spec.email         = ["jack.hayter@decathlon.com"]
+
+  spec.summary       = "Simple abstraction library for making HTTPS JSON calls"
+  spec.description   = "Provides a simple way of making HTTPS calls with different verbs, headers, params, and parsing the output as JSON"
+  spec.homepage      = "https://github.com/decathlon/https-json-rubygem"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/decathlon/https.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Decathlon
+
+  # Cleanly handles HTTPS requests to JSON apis
+  #
+  module HTTPS
+
+    VERSION = "0.1.0"
+
+    def self.json_api_request(base_url: '', params: {}, verb: :get, headers: {})
+
+      # Parse URI and build a new HTTPS client
+      #
+      uri = URI.parse(base_url)
+      raise 'InsecureRequestURL' unless uri.scheme == 'https'
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      # Don't include empty params
+      #
+      params = params.reject{ |_k, v| v.nil? }
+
+      # Use the HTTP verb to create a request and set params
+      #
+      case verb
+      when :get
+        uri.query = params.collect{ |k, v| "#{k}=#{v}" }.join('&')
+        request = ::Net::HTTP::Get.new(uri.request_uri)
+      when :delete
+        uri.query = params.collect{ |k, v| "#{k}=#{v}" }.join('&')
+        request = ::Net::HTTP::Delete.new(uri.request_uri)
+      when :post
+        request = ::Net::HTTP::Post.new(uri.request_uri)
+        request.body = JSON.dump(params)
+      when :put
+        request = ::Net::HTTP::Put.new(uri.request_uri)
+        request.body = JSON.dump(params)
+      when :patch
+        request = ::Net::HTTP::Patch.new(uri.request_uri)
+        request.body = JSON.dump(params)
+      else
+        raise 'Invalid HTTP verb'
+      end
+
+      # Add headers to the request
+      #
+      headers.each do |k, v|
+        request[k.to_s] = v
+      end
+
+      # Ensure request is JSON
+      #
+      request['Content-Type'] = 'application/json'
+
+      # Make an HTTPS query to the host and return a symbolized hash of the JSON response
+      #
+      return JSON.parse(http.request(request).body, symbolize_names: true)
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: decathlon-https
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Hayter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a simple way of making HTTPS calls with different verbs, headers,
+  params, and parsing the output as JSON
+email:
+- jack.hayter@decathlon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- decathlon-http.gemspec
+- lib/decathlon/https.rb
+homepage: https://github.com/decathlon/https-json-rubygem
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple abstraction library for making HTTPS JSON calls
+test_files: []