nice_json_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 855bcc473a81ee294429eaffaac2b91350436f5315c87ea79ad86615e43e7e39
+  data.tar.gz: 3603155c677271558df18ddac2afe1e534f4db267758566b76e7cba5959f742c
+SHA512:
+  metadata.gz: 5eb514697bd13319a32b11c2d60087b57079734a7ae44bb2237958578e27062b4e42ee80f4759c57341972e44ffad533a977d135d649b0e1c39bcbcd07ec95d5
+  data.tar.gz: 1895ea45fe3020bda021d0109e1a3eb379e6d283b680838e4ca1b008cb37ab8b7fa66d04d44e57e6617f564c906f08ff5ced7406ff7fbf3b5a195e7aeefb57d5

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/andycroll/rules/master/rubocop.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+  - 2.5.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andy@goodscary.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 nice_json_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andy Croll
+
+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,77 @@
+# NiceJsonApi
+
+A useful hundred-line-ish wrapper around `Net::HTTP` for well behaved JSON-based APIs.
+
+This gem can be used as a basis for http://jsonapi.org compatible APIs but it is not exclusively for that use. Any 'nice' JSON-based API should work.
+
+If you're looking for a good gem to use with JSON API I like [json-api-vanilla](https://github.com/trainline/json-api-vanilla).
+
+Supports Authorization:
+* HTTP Basic Auth
+* Bearer Token Auth (like Twitter)
+* Other header-based authorisation (custom header & value)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nice_json_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nice_json_api
+
+## Usage
+
+The main interface is:
+
+```ruby
+# A simple GET request
+> response = NiceJsonApi::Response.new('http://ip.jsontest.com')
+=> #<NiceJsonApi::Response:...>
+> response.code
+#=> '200'
+> response.body
+#=> { ip: '8.8.8.8' }
+> response.raw_body
+#=> "{\"ip\": \"146.199.147.93\"}\n"
+> response.message
+#=> "OK"
+> response.raw
+#=> #<Net::HTTPOK 200 OK readbody=true>
+
+# A Bearer token POST request
+> response = NiceJsonApi::Response.new('https://api.twitter.com/1.1/statuses/update.json',
+                                       auth: { bearer: "YOURTOKEN" },
+                                       body: { status: 'This gem is awesome' },
+                                       method: :post)
+
+# A custom header GET request
+> response = NiceJsonApi::Response.new('https://yourapiserver.com/',
+                                       auth: { header: { name: 'X-Weird-Auth', value: 'TOKEN' } })
+```
+
+## 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]/nice_json_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NiceJsonApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nice_json_api/blob/master/CODE_OF_CONDUCT.md).

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 "nice_json_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(__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/nice_json_api/internal/inflector.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module NiceJsonApi
+  module Internal
+    # Stolen verbatim from ActiveSupport
+    module Inflector
+      # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L272
+      # rubocop:disable all
+      def self.constantize(camel_cased_word)
+        names = camel_cased_word.split("::".freeze)
+
+        # Trigger a built-in NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check if it is owned directly. The check
+            # stops when we reach Object or the end of ancestors tree.
+            constant = constant.ancestors.inject(constant) do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+      # rubocop:enable all
+    end
+  end
+end

data/lib/nice_json_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NiceJsonApi
+  VERSION = '1.0.0'
+end

data/lib/nice_json_api.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+require 'nice_json_api/version'
+require 'nice_json_api/internal/inflector'
+
+module NiceJsonApi
+  # Response from a friendly API
+  class Response
+    def initialize(url, method: :get, body: nil, auth: nil)
+      @url = url.to_s
+      @method = method
+      @body = body
+      @auth = auth
+    end
+
+    def body
+      JSON.parse(raw_body) || {}
+    rescue JSON::ParserError
+      {}
+    end
+
+    def code
+      raw.code
+    end
+
+    def message
+      raw.message
+    end
+
+    def raw
+      @raw ||= fetch(initial_uri, method: @method, body: @body, auth: @auth)
+    end
+
+    def raw_body
+      raw.body
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def fetch(uri, method: :get, body: nil, limit: 10, auth: nil)
+      return NullResponse.new('404', '{}', 'Too Many Redirects') if limit.zero?
+
+      case response = SingleRequest.new(uri,
+                                        method: method,
+                                        body: body,
+                                        auth: auth).response
+      when Net::HTTPRedirection, Net::OpenTimeout
+        fetch(response['location'], method: method, body: body, limit: --limit, auth: auth)
+      else
+        response
+      end
+    rescue Errno::ECONNREFUSED
+      NullResponse.new('499', '{}', 'Host not found')
+    rescue Errno::EHOSTUNREACH
+      fetch(uri, method: method, body: body, limit: --limit, auth: auth)
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def initial_uri
+      @url = "https://#{@url}" unless @url[0..3] == 'http'
+      URI(@url)
+    end
+
+    # Do a single html request
+    class SingleRequest
+      def initialize(uri, method: :get, body: nil, auth: nil)
+        @uri = URI(uri)
+        @method = method
+        @body = body
+        @auth = Hash(auth)
+      end
+
+      def response
+        Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: ssl?) do |http|
+          http.request(req)
+        end
+      end
+
+      private
+
+      def auth_header
+        if @auth.key?(:user)
+          "Basic #{Base64.strict_encode64("#{@auth[:user]}:#{@auth[:password]}")}"
+        elsif @auth.key?(:bearer)
+          "Bearer #{@auth[:bearer]}"
+        end
+      end
+
+      def headers
+        {
+          'Accept' => 'application/json',
+          'Authorization' => auth_header,
+          'Content-Type' => @body ? 'application/json' : nil,
+          'User-Agent' => "NiceJsonApi Ruby #{VERSION}"
+        }.reject { |_, v| v.nil? }
+      end
+
+      def klass
+        NiceJsonApi::Internal::Inflector.constantize("Net::HTTP::#{@method.to_s.capitalize}")
+      end
+
+      def manual_header
+        return {} unless @auth.key?(:header)
+        { @auth[:header][:name] => @auth[:header][:value] }
+      end
+
+      def req
+        @req ||= begin
+          req = klass.new(@uri)
+          req.body = @body.to_json if @body
+          headers.merge(manual_header).each { |header, value| req[header] = value }
+          req
+        end
+      end
+
+      def ssl?
+        @uri.scheme == 'https'
+      end
+    end
+
+    NullResponse = Struct.new(:code, :body, :message)
+  end
+end

data/nice_json_api.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nice_json_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nice_json_api'
+  spec.version       = NiceJsonApi::VERSION
+  spec.authors       = ['Andy Croll']
+  spec.email         = ['andy@goodscary.com']
+
+  spec.summary       = 'A wrapper around Net::HTTP for any nice JSON API'
+  spec.description   = 'No dependancies other than Ruby’s standard Net::HTTP, allows you play nicely with nice JSON-based APIs'
+  spec.homepage      = 'https://github.com/andycroll/nice_json_api'
+  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', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: nice_json_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Croll
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: simplecov
+  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: 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: No dependancies other than Ruby’s standard Net::HTTP, allows you play
+  nicely with nice JSON-based APIs
+email:
+- andy@goodscary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nice_json_api.rb
+- lib/nice_json_api/internal/inflector.rb
+- lib/nice_json_api/version.rb
+- nice_json_api.gemspec
+homepage: https://github.com/andycroll/nice_json_api
+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.3
+signing_key: 
+specification_version: 4
+summary: A wrapper around Net::HTTP for any nice JSON API
+test_files: []