rest_dsl 0.1.7 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 00bb98474257dd1c053d322ec536f3aea68100881db224588f9fd7456d44c611
4
- data.tar.gz: 63207297bedf1699569e2e36f010e6169f696436548c25b515dfee8ee329aec3
3
+ metadata.gz: d9cbe8705486df5432dc60a709608903d99e3cd93c1ae95545e055a0c6e5ee02
4
+ data.tar.gz: 70a579028f4d7e228ec88feab969426e74201010f06833191d8c723389d749a2
5
5
  SHA512:
6
- metadata.gz: ab7eadd3a565e84ca8747fb347bd265ec2737c1751c5c813cb54979743ff9ee2fbc56304933b7c527f10c46fe76883353cf0c1005b7fd6cea2af6bb555e89d43
7
- data.tar.gz: 9cba9233525a7e15e171d3c3b332048b6a27c3cad83b7737ff317ff66d7f9640ad7d97b96dd6b5757e037d1b988f9ebc7c147f2b21ce1ea79e138f581b68589b
6
+ metadata.gz: be3a4ab3d5fbc03eb10eb99c27ae0af86935a38b12f14ce1186629e9d07d395e5ec615a89f7da7bc5651164aa7cf0426441d40b59c8cfe3d4a56821f2f02218b
7
+ data.tar.gz: e5309f677355640929f8b955bda644daf3f9a3effbb47189bb15c3a3e0fb558c2647f376f33562f03d259bd4daa43f1bc6614bb023d5c065d21ed1fb6866dd05
data/.gitignore CHANGED
@@ -1,15 +1,15 @@
1
- /.bundle/
2
- /.yardoc
3
- /_yardoc/
4
- /coverage/
5
- /doc/
6
- /pkg/
7
- /spec/reports/
8
- /tmp/
9
-
10
- # rspec failure tracking
11
- .rspec_status
12
-
13
- .idea
14
- examples.txt
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ .idea
14
+ examples.txt
15
15
  Gemfile.lock
data/.rspec CHANGED
@@ -1,3 +1,3 @@
1
- --format documentation
2
- --color
3
- --require spec_helper
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -1,7 +1,7 @@
1
- ---
2
- sudo: false
3
- language: ruby
4
- cache: bundler
5
- rvm:
6
- - 2.6.3
7
- before_install: gem install bundler -v 2.0.1
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 2.0.1
@@ -1,74 +1,74 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, gender identity and expression, level of experience,
9
- nationality, personal appearance, race, religion, or sexual identity and
10
- orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at ridgel@grangeinsurance.com. All
59
- complaints will be reviewed and investigated and will result in a response that
60
- is deemed necessary and appropriate to the circumstances. The project team is
61
- obligated to maintain confidentiality with regard to the reporter of an incident.
62
- Further details of specific enforcement policies may be posted separately.
63
-
64
- Project maintainers who do not follow or enforce the Code of Conduct in good
65
- faith may face temporary or permanent repercussions as determined by other
66
- members of the project's leadership.
67
-
68
- ## Attribution
69
-
70
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
- available at [http://contributor-covenant.org/version/1/4][version]
72
-
73
- [homepage]: http://contributor-covenant.org
74
- [version]: http://contributor-covenant.org/version/1/4/
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at ridgel@grangeinsurance.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source "https://rubygems.org"
2
-
3
- # Specify your gem's dependencies in rest_dsl.gemspec
4
- gemspec
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in rest_dsl.gemspec
4
+ gemspec
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2019 Luke Ridge
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Luke Ridge
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md CHANGED
@@ -1,41 +1,41 @@
1
- # RestDsl
2
-
3
- A simple dsl for defining rest service consumers in applications. Mostly intended for test framework use.
4
-
5
- ## Installation
6
-
7
- Add this line to your application's Gemfile:
8
-
9
- ```ruby
10
- gem 'rest_dsl'
11
- ```
12
-
13
- And then execute:
14
-
15
- $ bundle
16
-
17
- Or install it yourself as:
18
-
19
- $ gem install rest_dsl
20
-
21
- ## Usage
22
-
23
- [Check Out the Wiki](../../wiki)
24
-
25
- ## Development
26
-
27
- 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.
28
-
29
- 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).
30
-
31
- ## Contributing
32
-
33
- Bug reports and pull requests are welcome on GitHub at https://github.com/restDSL/rest_dsl_gem. 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.
34
-
35
- ## License
36
-
37
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
38
-
39
- ## Code of Conduct
40
-
41
- 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/restDSL/rest_dsl/blob/master/CODE_OF_CONDUCT.md).
1
+ # RestDsl
2
+
3
+ A simple dsl for defining rest service consumers in applications. Mostly intended for test framework use.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'rest_dsl'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install rest_dsl
20
+
21
+ ## Usage
22
+
23
+ [Check Out the Wiki](../../wiki)
24
+
25
+ ## Development
26
+
27
+ 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.
28
+
29
+ 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).
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/restDSL/rest_dsl_gem. 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.
34
+
35
+ ## License
36
+
37
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
38
+
39
+ ## Code of Conduct
40
+
41
+ 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/restDSL/rest_dsl/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile CHANGED
@@ -1,6 +1,6 @@
1
- require "bundler/gem_tasks"
2
- require "rspec/core/rake_task"
3
-
4
- RSpec::Core::RakeTask.new(:spec)
5
-
6
- task :default => :spec
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -1,14 +1,14 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "rest_dsl"
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require "irb"
14
- IRB.start(__FILE__)
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "rest_dsl"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup CHANGED
@@ -1,8 +1,8 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -1,40 +1,40 @@
1
- require_relative 'rest_dsl/version'
2
- require_relative 'rest_dsl/errors'
3
- require_relative 'rest_dsl/dsl'
4
- require 'psych'
5
- require 'json'
6
-
7
- module RestDSL
8
- class << self
9
- attr_reader :config_file_location
10
- attr_reader :use_config_file
11
- attr_reader :config
12
-
13
- def config_file_location=(arg)
14
- @config_file_location = arg
15
- load_config
16
- end
17
-
18
- def default_configs
19
- {}
20
- end
21
-
22
- def configuration
23
- @config
24
- end
25
-
26
- private
27
- def load_config
28
- @config =
29
- if File.exist?("#{config_file_location}/rest_dsl.yml")
30
- Psych.load_file("#{config_file_location}/rest_dsl.yml")
31
- else
32
- default_configs
33
- end
34
- end
35
- end
36
-
37
- @config_file_location = './config'
38
- load_config
39
-
1
+ require_relative 'rest_dsl/version'
2
+ require_relative 'rest_dsl/errors'
3
+ require_relative 'rest_dsl/dsl'
4
+ require 'psych'
5
+ require 'json'
6
+
7
+ module RestDSL
8
+ class << self
9
+ attr_reader :config_file_location
10
+ attr_reader :use_config_file
11
+ attr_reader :config
12
+
13
+ def config_file_location=(arg)
14
+ @config_file_location = arg
15
+ load_config
16
+ end
17
+
18
+ def default_configs
19
+ {}
20
+ end
21
+
22
+ def configuration
23
+ @config
24
+ end
25
+
26
+ private
27
+ def load_config
28
+ @config =
29
+ if File.exist?("#{config_file_location}/rest_dsl.yml")
30
+ Psych.load_file("#{config_file_location}/rest_dsl.yml")
31
+ else
32
+ default_configs
33
+ end
34
+ end
35
+ end
36
+
37
+ @config_file_location = './config'
38
+ load_config
39
+
40
40
  end
@@ -1,63 +1,64 @@
1
- require 'rest-client'
2
- require 'psych'
3
- require 'json'
4
-
5
- module RestDSL
6
- class Client
7
-
8
- class << self
9
- attr_accessor :methods_without_payloads, :config_dir
10
-
11
- def environments
12
- RestDSL.configuration[:environments]
13
- end
14
-
15
- end
16
-
17
- attr_accessor :base_url
18
-
19
- @methods_without_payloads = %i[get delete head options]
20
-
21
- def initialize(environment = nil, base_url: nil)
22
- if base_url
23
- @base_url = base_url
24
- else
25
- environment = environment.to_sym
26
- environmental_info = environments.fetch(environment) do
27
- raise RestDSL::UndefinedEnvironmentError.new(environment, environments)
28
- end
29
- @base_url = "#{environmental_info[:url]}"
30
- end
31
- end
32
-
33
- def execute(method, endpoint, headers, payload: nil, **hash_args, &block)
34
- url = "#{@base_url}/#{endpoint}"
35
- args = { method: method.to_sym, url: url, headers: headers }
36
- args.merge!(payload: payload) if payload && method_has_payload?(method)
37
- args.merge!(hash_args)
38
-
39
- response =
40
- begin
41
- RestClient::Request.new(args).execute(&block)
42
- rescue RestClient::ExceptionWithResponse => e
43
- e.response
44
- end
45
- { response: response, parsed: JSON.parse(response, symbolize_names: true) }
46
- rescue JSON::ParserError => e
47
- { response: response, parsed: "Failed to parse, see response for more information, code was: #{response.code}, message was: #{response.body}" }
48
- end
49
-
50
- def method_has_payload?(method)
51
- !self.class.methods_without_payloads.include?(method)
52
- end
53
-
54
- def environments
55
- self.class.environments
56
- end
57
-
58
- def self.default_headers
59
- { accept: 'application/json' }
60
- end
61
-
62
- end
1
+ require 'rest-client'
2
+ require 'psych'
3
+ require 'json'
4
+ require 'addressable'
5
+
6
+ module RestDSL
7
+ class Client
8
+
9
+ class << self
10
+ attr_accessor :methods_without_payloads, :config_dir
11
+
12
+ def environments
13
+ RestDSL.configuration[:environments]
14
+ end
15
+
16
+ end
17
+
18
+ attr_accessor :base_url
19
+
20
+ @methods_without_payloads = %i[get delete head options]
21
+
22
+ def initialize(environment = nil, base_url: nil)
23
+ if base_url
24
+ @base_url = base_url
25
+ else
26
+ environment = environment.to_sym
27
+ environmental_info = environments.fetch(environment) do
28
+ raise RestDSL::UndefinedEnvironmentError.new(environment, environments)
29
+ end
30
+ @base_url = "#{environmental_info[:url]}"
31
+ end
32
+ end
33
+
34
+ def execute(method, endpoint, headers, payload: nil, **hash_args, &block)
35
+ url = "#{@base_url}/#{endpoint}"
36
+ args = { method: method.to_sym, url: Addressable::URI.escape(url), headers: headers }
37
+ args.merge!(payload: payload) if payload && method_has_payload?(method)
38
+ args.merge!(hash_args)
39
+
40
+ response =
41
+ begin
42
+ RestClient::Request.new(args).execute(&block)
43
+ rescue RestClient::ExceptionWithResponse => e
44
+ e.response
45
+ end
46
+ { response: response, parsed: JSON.parse(response.to_s, symbolize_names: true) }
47
+ rescue JSON::ParserError => e
48
+ { response: response, parsed: "Failed to parse, see response for more information, code was: #{response.code}, message was: #{response.body}" }
49
+ end
50
+
51
+ def method_has_payload?(method)
52
+ !self.class.methods_without_payloads.include?(method)
53
+ end
54
+
55
+ def environments
56
+ self.class.environments
57
+ end
58
+
59
+ def self.default_headers
60
+ { accept: 'application/json' }
61
+ end
62
+
63
+ end
63
64
  end
@@ -1,42 +1,42 @@
1
- require 'json'
2
- require 'psych'
3
-
4
- module RestDSL
5
-
6
- ##
7
- # A collection of DSL extensions for use with various worlds to allow the use of some simpler
8
- # dsl language in them.
9
- #
10
- # For rspec, in spec helper add config.extend RestDSL::DSLExtensions::<<extension>>
11
- # In cucumber World(RestDSL::DSLExtensions::<<extension>>)
12
- # Each extension can also be extended onto a class like normal to use it in that class
13
- module DSLExtensions
14
-
15
- ##
16
- # Adds a DSL method for parsing information from a file, parser list can be overridden by redefining file_parsers
17
- # If no parser is designed, for the file extension, loads the file as plain text
18
- module FromFile
19
-
20
- def file_parsers
21
- {
22
- %w[.json] => JSON,
23
- %w[.yml .yaml] => Psych
24
- }
25
- end
26
-
27
- def from_file(file_name)
28
- parser = file_parsers.find{|key, _| key.any? {|file_type| file_name.include? file_type}}&.[](1)
29
- result = if parser.eql?(Psych)
30
- parser.load_file(file_name)
31
- elsif parser.eql?(JSON)
32
- parser.parse(File.read(file_name))
33
- end
34
- result ||= File.new(file_name)
35
- result
36
- rescue Errno::ENOENT => e
37
- e.message << " relative to directory #{Dir.pwd}"
38
- raise e
39
- end
40
- end
41
- end
1
+ require 'json'
2
+ require 'psych'
3
+
4
+ module RestDSL
5
+
6
+ ##
7
+ # A collection of DSL extensions for use with various worlds to allow the use of some simpler
8
+ # dsl language in them.
9
+ #
10
+ # For rspec, in spec helper add config.extend RestDSL::DSLExtensions::<<extension>>
11
+ # In cucumber World(RestDSL::DSLExtensions::<<extension>>)
12
+ # Each extension can also be extended onto a class like normal to use it in that class
13
+ module DSLExtensions
14
+
15
+ ##
16
+ # Adds a DSL method for parsing information from a file, parser list can be overridden by redefining file_parsers
17
+ # If no parser is designed, for the file extension, loads the file as plain text
18
+ module FromFile
19
+
20
+ def file_parsers
21
+ {
22
+ %w[.json] => JSON,
23
+ %w[.yml .yaml] => Psych
24
+ }
25
+ end
26
+
27
+ def from_file(file_name)
28
+ parser = file_parsers.find{|key, _| key.any? {|file_type| file_name.include? file_type}}&.[](1)
29
+ result = if parser.eql?(Psych)
30
+ parser.load_file(file_name)
31
+ elsif parser.eql?(JSON)
32
+ parser.parse(File.read(file_name))
33
+ end
34
+ result ||= File.new(file_name)
35
+ result
36
+ rescue Errno::ENOENT => e
37
+ e.message << " relative to directory #{Dir.pwd}"
38
+ raise e
39
+ end
40
+ end
41
+ end
42
42
  end
@@ -1,14 +1,14 @@
1
- module RestDSL
2
- class ErrorBase < StandardError
3
- def initialize(message)
4
- message = "[RestDSL] #{message}"
5
- super(message)
6
- end
7
- end
8
- class UndefinedEnvironmentError < ErrorBase
9
- def initialize(environment, available_envs)
10
- message = "Undefined environment, #{environment}, known environments: #{available_envs.keys.join(', ')}"
11
- super(message)
12
- end
13
- end
1
+ module RestDSL
2
+ class ErrorBase < StandardError
3
+ def initialize(message)
4
+ message = "[RestDSL] #{message}"
5
+ super(message)
6
+ end
7
+ end
8
+ class UndefinedEnvironmentError < ErrorBase
9
+ def initialize(environment, available_envs)
10
+ message = "Undefined environment, #{environment}, known environments: #{available_envs.keys.join(', ')}"
11
+ super(message)
12
+ end
13
+ end
14
14
  end
@@ -1,93 +1,93 @@
1
- require 'psych'
2
- require_relative 'client'
3
-
4
- module RestDSL
5
-
6
- ##
7
- # Base Class for defining a rest service DSL Object.
8
- # Will look in a config file contained in the same directory as the service defining its headers and/or creds
9
- # by environment. This file should be named such that it matches the service file name with a .yml ending.
10
- class ServiceBase
11
-
12
- def self.inherited(clazz)
13
- clazz.class_eval do
14
- @file_name = caller_locations[2].path
15
- @config_file = @file_name.gsub('.rb', '.yml')
16
- end
17
- end
18
-
19
- class << self
20
- attr_reader :environment, :file_name, :client, :config_file, :last_response
21
- attr_writer :headers, :authentication, :service_name
22
-
23
- # Initializes the singleton
24
- def environment=(environment)
25
- @environment = environment
26
- @client = Client.new(environment)
27
- self
28
- end
29
-
30
- def rest_call(method, name, url_schema)
31
- self.class.define_method("#{method}_#{name}") do |*args, headers: nil, payload: nil, params: nil, url_args: nil, **hash_args|
32
- execute_request(method, url_schema.dup, *args, **hash_args, headers: headers, payload: payload, params: params, url_args: url_args)
33
- end
34
- end
35
-
36
- # The method wrapped by the methods generated by rest_call, these methods all follow this blueprint
37
- # Can by wrapped manually to create more complicated logic than what's supported by the default generators
38
- def execute_request(method, rest_method_call, *args, headers: nil, payload: nil, params: nil, url_args: nil, form_data: nil, **hash_args, &block)
39
- headers ||= self.headers
40
- url_args ||= {}
41
- service_name = "#{@service_name}/" unless @service_name&.empty?
42
- hash_args.merge!(auth)
43
- hash_args.merge!(payload: payload.to_json) if payload
44
- hash_args.merge!(payload: form_data) if form_data
45
- sub_url_args!(url_args, rest_method_call)
46
- arg_list = [method, "#{service_name}#{rest_method_call}#{build_params(params)}", headers]
47
- response = @client.execute(*arg_list, *args, **hash_args, &block)
48
- @last_response = response[:response]
49
- response[:parsed]
50
- end
51
-
52
- def build_params(params)
53
- params ||= {}
54
- return "" if params.empty?
55
- "?#{params.map{|key,value| "#{key}=#{value}"}.join('&')}" unless params.empty?
56
- end
57
-
58
- def sub_url_args!(arg_list, rest_method_call)
59
- # Given the protocol is handled by the client and not service_base, this should be a safe enough pattern in most cases
60
- arg_list.each{ |arg_name, value| rest_method_call.gsub!(":#{arg_name}", value) }
61
- end
62
-
63
- def config
64
- @config || reload_config
65
- end
66
-
67
- def config_file=(file_name)
68
- @config_file = file_name
69
- reload_config
70
- end
71
-
72
- def reload_config
73
- @config = Psych.load_file(@config_file)[@environment] if File.exist?(@config_file)
74
- @config = {} unless File.exist?(@config_file)
75
- @config
76
- end
77
-
78
- def auth
79
- @authentication || config&.[](:credentials) || {}
80
- end
81
-
82
- def headers
83
- @headers ||= config&.[](:headers) || {}
84
- end
85
- end
86
-
87
- def service_name
88
- self.class.instance_variable_get(:@service_name)
89
- end
90
- end
91
-
92
- end
93
-
1
+ require 'psych'
2
+ require_relative 'client'
3
+
4
+ module RestDSL
5
+
6
+ ##
7
+ # Base Class for defining a rest service DSL Object.
8
+ # Will look in a config file contained in the same directory as the service defining its headers and/or creds
9
+ # by environment. This file should be named such that it matches the service file name with a .yml ending.
10
+ class ServiceBase
11
+
12
+ def self.inherited(clazz)
13
+ clazz.class_eval do
14
+ @file_name = caller_locations[2].path
15
+ @config_file = @file_name.gsub('.rb', '.yml')
16
+ end
17
+ end
18
+
19
+ class << self
20
+ attr_reader :environment, :file_name, :client, :config_file, :last_response
21
+ attr_writer :headers, :authentication, :service_name
22
+
23
+ # Initializes the singleton
24
+ def environment=(environment)
25
+ @environment = environment
26
+ @client = Client.new(environment)
27
+ self
28
+ end
29
+
30
+ def rest_call(method, name, url_schema)
31
+ self.class.define_method("#{method}_#{name}") do |*args, headers: nil, payload: nil, params: nil, url_args: nil, **hash_args|
32
+ execute_request(method, url_schema.dup, *args, **hash_args, headers: headers, payload: payload, params: params, url_args: url_args)
33
+ end
34
+ end
35
+
36
+ # The method wrapped by the methods generated by rest_call, these methods all follow this blueprint
37
+ # Can by wrapped manually to create more complicated logic than what's supported by the default generators
38
+ def execute_request(method, rest_method_call, *args, headers: nil, payload: nil, params: nil, url_args: nil, form_data: nil, **hash_args, &block)
39
+ headers ||= self.headers
40
+ url_args ||= {}
41
+ service_name = "#{@service_name}/" unless @service_name&.empty?
42
+ hash_args.merge!(auth)
43
+ hash_args.merge!(payload: payload.to_json) if payload
44
+ hash_args.merge!(payload: form_data) if form_data
45
+ sub_url_args!(url_args, rest_method_call)
46
+ arg_list = [method, "#{service_name}#{rest_method_call}#{build_params(params)}", headers]
47
+ response = @client.execute(*arg_list, *args, **hash_args, &block)
48
+ @last_response = response[:response]
49
+ response[:parsed]
50
+ end
51
+
52
+ def build_params(params)
53
+ params ||= {}
54
+ return "" if params.empty?
55
+ "?#{params.map{|key,value| "#{key}=#{value}"}.join('&')}" unless params.empty?
56
+ end
57
+
58
+ def sub_url_args!(arg_list, rest_method_call)
59
+ # Given the protocol is handled by the client and not service_base, this should be a safe enough pattern in most cases
60
+ arg_list.each{ |arg_name, value| rest_method_call.gsub!(":#{arg_name}", value) }
61
+ end
62
+
63
+ def config
64
+ @config || reload_config
65
+ end
66
+
67
+ def config_file=(file_name)
68
+ @config_file = file_name
69
+ reload_config
70
+ end
71
+
72
+ def reload_config
73
+ @config = Psych.load_file(@config_file)[@environment] if File.exist?(@config_file)
74
+ @config = {} unless File.exist?(@config_file)
75
+ @config
76
+ end
77
+
78
+ def auth
79
+ @authentication || config&.[](:credentials) || {}
80
+ end
81
+
82
+ def headers
83
+ @headers ||= config&.[](:headers) || {}
84
+ end
85
+ end
86
+
87
+ def service_name
88
+ self.class.instance_variable_get(:@service_name)
89
+ end
90
+ end
91
+
92
+ end
93
+
@@ -1,3 +1,3 @@
1
- module RestDSL
2
- VERSION = '0.1.7'.freeze
3
- end
1
+ module RestDSL
2
+ VERSION = '0.1.8'.freeze
3
+ end
@@ -1,40 +1,41 @@
1
- lib = File.expand_path('../lib', __FILE__)
2
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
- require 'rest_dsl/version'
4
-
5
- Gem::Specification.new do |spec|
6
- spec.name = 'rest_dsl'
7
- spec.version = RestDSL::VERSION
8
- spec.authors = ['Luke Ridge']
9
- spec.email = ['ridgel@grangeinsurance.com']
10
-
11
- spec.summary = %q{A Simple DSL for writing rest services}
12
- spec.homepage = "https://github.com/castone22/rest_dsl_gem"
13
- spec.license = 'MIT'
14
-
15
- # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
16
- # to allow pushing to a single host or delete this section to allow pushing to any host.
17
- if spec.respond_to?(:metadata)
18
- spec.metadata['homepage_uri'] = spec.homepage
19
- spec.metadata['source_code_uri'] = "https://github.com/castone22/rest_dsl_gem"
20
- spec.metadata['changelog_uri'] = "https://github.com/castone22/rest_dsl_gem"
21
- else
22
- raise 'RubyGems 2.0 or newer is required to protect against ' \
23
- 'public gem pushes.'
24
- end
25
-
26
- # Specify which files should be added to the gem when it is released.
27
- # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
28
- spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
29
- `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
30
- end
31
- spec.bindir = 'exe'
32
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
33
- spec.require_paths = ['lib']
34
-
35
- spec.add_development_dependency 'bundler', '~> 2.0'
36
- spec.add_development_dependency 'rake', '~> 10.0'
37
- spec.add_development_dependency 'rspec', '~> 3.0'
38
- spec.add_development_dependency 'rest-client'
39
-
40
- end
1
+ lib = File.expand_path('../lib', __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'rest_dsl/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'rest_dsl'
7
+ spec.version = RestDSL::VERSION
8
+ spec.authors = ['Luke Ridge']
9
+ spec.email = ['ridgel@grangeinsurance.com']
10
+
11
+ spec.summary = %q{A Simple DSL for writing rest services}
12
+ spec.homepage = "https://github.com/castone22/rest_dsl_gem"
13
+ spec.license = 'MIT'
14
+
15
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
16
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
17
+ if spec.respond_to?(:metadata)
18
+ spec.metadata['homepage_uri'] = spec.homepage
19
+ spec.metadata['source_code_uri'] = "https://github.com/castone22/rest_dsl_gem"
20
+ spec.metadata['changelog_uri'] = "https://github.com/castone22/rest_dsl_gem"
21
+ else
22
+ raise 'RubyGems 2.0 or newer is required to protect against ' \
23
+ 'public gem pushes.'
24
+ end
25
+
26
+ # Specify which files should be added to the gem when it is released.
27
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
28
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
29
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
30
+ end
31
+ spec.bindir = 'exe'
32
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
33
+ spec.require_paths = ['lib']
34
+
35
+ spec.add_development_dependency 'bundler', '~> 2.0'
36
+ spec.add_development_dependency 'rake', '~> 10.0'
37
+ spec.add_development_dependency 'rspec', '~> 3'
38
+ spec.add_dependency 'rest-client', '~> 2 '
39
+ spec.add_dependency 'addressable', '~> 2'
40
+
41
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rest_dsl
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.7
4
+ version: 0.1.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Luke Ridge
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2019-09-20 00:00:00.000000000 Z
11
+ date: 2020-01-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -44,28 +44,42 @@ dependencies:
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: '3.0'
47
+ version: '3'
48
48
  type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '3.0'
54
+ version: '3'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: rest-client
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ">="
59
+ - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '0'
62
- type: :development
61
+ version: '2'
62
+ type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ">="
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: addressable
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
67
81
  - !ruby/object:Gem::Version
68
- version: '0'
82
+ version: '2'
69
83
  description:
70
84
  email:
71
85
  - ridgel@grangeinsurance.com
@@ -112,7 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
112
126
  - !ruby/object:Gem::Version
113
127
  version: '0'
114
128
  requirements: []
115
- rubygems_version: 3.0.3
129
+ rubyforge_project:
130
+ rubygems_version: 2.7.6.2
116
131
  signing_key:
117
132
  specification_version: 4
118
133
  summary: A Simple DSL for writing rest services