rest_dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f39a5eba524c66c73ddfb7050bab857d4f37913fd5f10d4367b27a3f4141f87
+  data.tar.gz: c21b310943a34d6aaa9b8ef7a59faccdc9368ea8315d36a0c019278072de1662
+SHA512:
+  metadata.gz: c041761b8b59888857aa450c69b051d97c3f44021c9ca00bbeb90a45cecd199f06789e65129b97923668440531e3cfa3884dcdc50eb3df51735c696c0ca70113
+  data.tar.gz: 3446e2643304cd1152612e7695821a4c26765134a8463aae77539a0d07580360f3c71b7495a12d727949d69ce29056ace5db1555572d2a204f831e07644ad586

data/.gitignore

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

data/.rspec

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

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.1

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 ridgel@grangeinsurance.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rest_dsl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Luke Ridge
+
+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,43 @@
+# RestDsl
+
+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/rest_dsl`. 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 'rest_dsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rest_dsl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/rest_dsl. 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 RestDsl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rest_dsl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rest_dsl"
+
+# 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/rest_dsl/client.rb

@@ -0,0 +1,63 @@
+require 'rest-client'
+require 'psych'
+require 'json'
+
+module RestDSL
+  class Client
+
+    class << self
+      attr_accessor :methods_without_payloads, :config_dir
+
+      def environments
+        RestDSL.configuration[:environments]
+      end
+
+    end
+
+    attr_accessor :base_url
+
+    @methods_without_payloads = %i[get delete head options]
+
+    def initialize(environment = nil, base_url: nil)
+      if base_url
+        @base_url = base_url
+      else
+        environment = environment.to_sym
+        environmental_info = environments.fetch(environment) do
+          raise RestDSL::UndefinedEnvironmentError.new(environment, environments)
+        end
+        @base_url = "#{environmental_info[:url]}"
+      end
+    end
+
+    def execute(method, endpoint, headers, payload: nil, **hash_args, &block)
+      url = "#{@base_url}/#{endpoint}"
+      args = { method: method.to_sym, url: url, headers: headers }
+      args.merge!(payload: payload) if payload && method_has_payload?(method)
+      args.merge!(hash_args)
+
+      response =
+        begin
+          RestClient::Request.new(args).execute(&block)
+        rescue RestClient::ExceptionWithResponse => e
+          e.response
+        end
+      { response: response, parsed: JSON.parse(response, symbolize_names: true) }
+    rescue JSON::ParserError => e
+      { response: response, parsed: "Failed to parse, see response for more information, code was: #{response.code}, message was: #{response.body}" }
+    end
+
+    def method_has_payload?(method)
+      !self.class.methods_without_payloads.include?(method)
+    end
+
+    def environments
+      self.class.environments
+    end
+
+    def self.default_headers
+      { accept: 'application/json' }
+    end
+
+  end
+end

data/lib/rest_dsl/errors.rb

@@ -0,0 +1,14 @@
+module RestDSL
+  class ErrorBase < StandardError
+    def initialize(message)
+      message = "[RestDSL] #{message}"
+      super(message)
+    end
+  end
+  class UndefinedEnvironmentError < ErrorBase
+    def initialize(environment, available_envs)
+      message = "Undefined environment, #{environment}, known environments: #{available_envs.keys.join(', ')}"
+      super(message)
+    end
+  end
+end

data/lib/rest_dsl/service_base.rb

@@ -0,0 +1,91 @@
+require 'psych'
+require_relative 'client'
+
+module RestDSL
+
+  ##
+  # Base Class for defining a rest service DSL Object.
+  # Will look in a config file contained in the same directory as the service defining its headers and/or creds
+  # by environment.  This file should be named such that it matches the service file name with a .yml ending.
+  class ServiceBase
+
+    def self.inherited(clazz)
+      clazz.class_eval do
+        @file_name = caller_locations[2].path
+        @config_file = @file_name.gsub('.rb', '.yml')
+      end
+    end
+
+    class << self
+      attr_reader :environment, :file_name, :client, :config_file, :last_response
+      attr_writer :headers, :authentication
+
+      # Initializes the singleton
+      def environment=(environment)
+        @environment = environment
+        @client = Client.new(environment)
+        self
+      end
+
+      def service_name=(name)
+        @service_name = name
+      end
+
+      def rest_call(method, name, url_schema)
+        self.class.define_method("#{method}_#{name}") do |*args, headers: nil, payload: nil, params: nil, url_args: nil, **hash_args|
+          execute_request(method, url_schema.dup, *args, **hash_args, headers: headers, payload: payload, params: params, url_args: url_args)
+        end
+      end
+
+      # The method wrapped by the methods generated by rest_call, these methods all follow this blueprint
+      # Can by wrapped manually to create more complicated logic than what's supported by the default generators
+      def execute_request(method, rest_method_call, *args, headers: nil, payload: nil, params: nil, url_args: nil, **hash_args, &block)
+        headers ||= self.headers
+        params ||= {}
+        url_args ||= {}
+        params = "?#{params.map{|key,value| "#{key}=#{value}"}.join('&')}"
+        service_name = "#{@service_name}/" unless @service_name&.empty?
+        hash_args.merge!(auth)
+        hash_args.merge!(payload: payload) if payload
+        sub_url_args!(url_args, rest_method_call)
+        arg_list = [method, "#{service_name}#{rest_method_call}#{params}", headers]
+        response = @client.execute(*arg_list, *args, **hash_args, &block)
+        @last_response = response[:response]
+        response[:parsed]
+      end
+
+      def sub_url_args!(arg_list, rest_method_call)
+        # Given the protocol is handled by the client and not service_base, this should be a safe enough pattern in most cases
+        arg_list.each{ |arg_name, value| rest_method_call.gsub!(":#{arg_name}", value) }
+      end
+
+      def config
+        @config || reload_config
+      end
+
+      def config_file=(file_name)
+        @config_file = file_name
+        reload_config
+      end
+
+      def reload_config
+        @config = Psych.load_file(@config_file)[@environment] if File.exist?(@config_file)
+        @config = {} unless File.exist?(@config_file)
+      end
+
+      def auth
+        @authentication || config&.[](:credentials) || {}
+      end
+
+      def headers
+        @headers ||= config&.[](:headers) || {}
+      end
+    end
+
+    def service_name
+      self.class.instance_variable_get(:@service_name)
+    end
+  end
+
+end
+

data/lib/rest_dsl/version.rb

@@ -0,0 +1,3 @@
+module RestDSL
+  VERSION = '0.1.0'
+end

data/lib/rest_dsl.rb

@@ -0,0 +1,39 @@
+require_relative 'rest_dsl/version'
+require_relative 'rest_dsl/errors'
+require 'psych'
+require 'json'
+
+module RestDSL
+  class << self
+    attr_reader :config_file_location
+    attr_reader :use_config_file
+    attr_reader :config
+
+    def config_file_location=(arg)
+      @config_file_location = arg
+      load_config
+    end
+
+    def default_configs
+      {}
+    end
+
+    def configuration
+      @config
+    end
+
+    private
+    def load_config
+      @config =
+        if File.exist?("#{config_file_location}/rest_dsl.yml")
+          Psych.load_file("#{config_file_location}/rest_dsl.yml")
+        else
+          default_configs
+        end
+    end
+  end
+
+  @config_file_location = './config'
+  load_config
+
+end

data/rest_dsl.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rest_dsl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rest_dsl'
+  spec.version       = RestDSL::VERSION
+  spec.authors       = ['Luke Ridge']
+  spec.email         = ['ridgel@grangeinsurance.com']
+
+  spec.summary       = %q{A Simple DSL for writing rest services}
+  spec.homepage      = "https://github.com/castone22/rest_dsl_gem"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = "https://github.com/castone22/rest_dsl_gem"
+    spec.metadata['changelog_uri'] = "https://github.com/castone22/rest_dsl_gem"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rest-client'
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rest_dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Ridge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-31 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: 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: rest-client
+  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: 
+email:
+- ridgel@grangeinsurance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rest_dsl.rb
+- lib/rest_dsl/client.rb
+- lib/rest_dsl/errors.rb
+- lib/rest_dsl/service_base.rb
+- lib/rest_dsl/version.rb
+- rest_dsl.gemspec
+homepage: https://github.com/castone22/rest_dsl_gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/castone22/rest_dsl_gem
+  source_code_uri: https://github.com/castone22/rest_dsl_gem
+  changelog_uri: https://github.com/castone22/rest_dsl_gem
+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: A Simple DSL for writing rest services
+test_files: []