mu-rest_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb359e262bb9f0cda43b64ce4a6c13e5ffdc19095f920bbfe7fca08dad03743a
+  data.tar.gz: 2d1b924b0670839d6266118e1902652e5a4447ad0dfc96f1e2f417140114f4f6
+SHA512:
+  metadata.gz: c3fc10e72baff4dadbcfb6a36b0de80a9e69a8fcb2b7138f6cc8892e31098729660b97182d6da9c1417edb2a21c88a17cae0b65959618b7eb2dd8ba2228e4d64
+  data.tar.gz: 4be0407b85e3e7519b8bf68c0bf146050e32d57cd0a853c470099231105f7f0e5ed2569a80074a2c602d1cc42e82d5715d3bee644cffb56965f32393893c5c72

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Mu::RestClient's Changelog
+
+## 2020-01-17
+
+🎉 Genesis.

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 root@olisti.co. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mu-rest_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    mu-rest_client (0.1.0)
+      mu-json (~> 0.1)
+      mu-result (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    mu-json (0.1.0)
+      mu-result (~> 1.2)
+    mu-result (1.2.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  mu-rest_client!
+  pry (~> 0.12)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 olistik
+
+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,101 @@
+# Mu::RestClient
+
+This is a REST client I made for fun. ❤️
+
+It is simple, yet flexible enough for my use cases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mu-rest_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mu-rest_client
+
+## Usage
+
+Require it:
+
+```ruby
+require 'mu/rest-client'
+```
+
+### Success
+
+```ruby
+result = Mu::RestClient.api_request(
+  domain: 'reqres.in',
+  path: '/api/users/2',
+)
+result.success? # => true
+result.unwrap(:http_code) # => '200'
+result.unwrap(:body)
+# => {"data"=>
+#   {"id"=>2,
+#    "email"=>"janet.weaver@reqres.in",
+#    "first_name"=>"Janet",
+#    "last_name"=>"Weaver",
+#    "avatar"=>"https://s3.amazonaws.com/uifaces/faces/twitter/josephstein/128.jpg"}}
+```
+
+### Error 404
+
+```ruby
+result = Mu::RestClient.api_request(
+  domain: 'reqres.in',
+  path: '/api/users/23',
+)
+result.error? # => true
+result.code # => :http_error
+result.unwrap(:http_code) # => '404'
+result.unwrap(:response) # => #<Net::HTTPNotFound 404 Not Found readbody=true>
+result.unwrap(:body) # => {}
+```
+
+### Error 400
+
+```ruby
+result = Mu::RestClient.api_request(domain: 'reqres.in', path: '/api/login', method: :post, body_params: { email: "peter@klaven" })
+result.error? # => true
+result.http_code # => '400'
+result.unwrap(:body) # => {"error"=>"Missing email or username"}
+```
+
+### Success 204
+
+```ruby
+result = Mu::RestClient.api_request(
+  domain: 'reqres.in',
+  path: '/api/users/2',
+  method: :delete,
+  success_codes: ['204'],
+)
+result.success? # => true
+result.http_code # => '204'
+```
+
+## 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://source.olisti.co/olistik/mu-rest_client. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mu::RestClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://source.olisti.co/olistik/mu-rest_client/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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mu/rest_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

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/mu/rest_client.rb

@@ -0,0 +1,85 @@
+require "mu/rest_client/version"
+require 'net/http'
+require 'uri'
+require 'json'
+require 'mu/result'
+require 'mu/json'
+
+module Mu
+  module RestClient
+    include Mu
+    extend self
+
+    def api_request(method: :get, domain:, scheme: 'https', path: '/', uri_params: {}, body_params: {}, headers: {}, success_codes: ['200'], is_json: true)
+      result = request(
+        method: method,
+        scheme: scheme,
+        domain: domain,
+        path: path,
+        body_params: body_params,
+        uri_params: uri_params,
+        headers: headers,
+      )
+      return result if result.error?
+      response = result.data[:response]
+
+      application_response(
+        response: response,
+        success_codes: success_codes,
+        is_json: is_json,
+      )
+    end
+
+    private
+
+    def request_class(method:)
+      case method
+      when :get then Net::HTTP::Get
+      when :post then Net::HTTP::Post
+      when :delete then Net::HTTP::Delete
+      when :put then Net::HTTP::Put
+      when :patch then Net::HTTP::Patch
+      else
+        raise "HTTP method '#{method}' is not recognized."
+      end
+    end
+
+    def request(method: :get, domain:, scheme: 'https', path: '/', uri_params: {}, body_params: {}, headers: {})
+      draft_uri = "#{scheme}://#{domain}#{path}"
+      if uri_params.any?
+        draft_uri = "#{draft_uri}?#{URI.encode_www_form(uri_params)}"
+      end
+      uri = URI(draft_uri)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: scheme == 'https') do |http|
+        request = request_class(method: method).new(uri)
+        if headers.any?
+          headers.each do |key, value|
+            request[key] = value
+          end
+        end
+        if body_params.any?
+          request.body = ::JSON.generate(body_params)
+        end
+        response = http.request(request)
+        Result.success(response: response)
+      end
+    end
+
+    def application_response(response:, success_codes: ['200'], is_json: true)
+      data = {
+        response: response,
+        http_code: response.code,
+      }
+      if is_json && response.body != nil
+        result = ::Mu::JSON.parse(response.body)
+        return result if result.error?
+
+        data[:body] = result.unwrap
+      end
+      is_success = success_codes.include?(response.code)
+      return Result.error(data).code!(:http_error) unless is_success
+
+      Result.success(data)
+    end
+  end
+end

data/lib/mu/rest_client/version.rb

@@ -0,0 +1,5 @@
+module Mu
+  module RestClient
+    VERSION = "0.1.0"
+  end
+end

data/mu-rest_client.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mu/rest_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mu-rest_client"
+  spec.version       = Mu::RestClient::VERSION
+  spec.authors       = ["olistik"]
+  spec.email         = ["root@olisti.co"]
+
+  spec.summary       = %q{Yet another REST client implementation.}
+  spec.description   = %q{This is a REST client I developed for fun.}
+  spec.homepage      = "https://source.olisti.co/olistik/mu-rest-client"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://source.olisti.co/olistik/mu-rest-client"
+  spec.metadata["changelog_uri"] = "https://source.olisti.co/olistik/mu-rest-client/blob/master/CHANGELOG.md"
+
+  # 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('..', __FILE__)) 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "mu-result", "~> 1.2"
+  spec.add_runtime_dependency "mu-json", "~> 0.1"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: mu-rest_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- olistik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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: mu-result
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mu-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This is a REST client I developed for fun.
+email:
+- root@olisti.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mu/rest_client.rb
+- lib/mu/rest_client/version.rb
+- mu-rest_client.gemspec
+homepage: https://source.olisti.co/olistik/mu-rest-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://source.olisti.co/olistik/mu-rest-client
+  source_code_uri: https://source.olisti.co/olistik/mu-rest-client
+  changelog_uri: https://source.olisti.co/olistik/mu-rest-client/blob/master/CHANGELOG.md
+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.6
+signing_key: 
+specification_version: 4
+summary: Yet another REST client implementation.
+test_files: []