rest_dsl 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f39a5eba524c66c73ddfb7050bab857d4f37913fd5f10d4367b27a3f4141f87
-  data.tar.gz: c21b310943a34d6aaa9b8ef7a59faccdc9368ea8315d36a0c019278072de1662
+  metadata.gz: 065d9784032984b8e45ec01e90b36b210c43fa389c480ac1374a5c9eae0ec46d
+  data.tar.gz: 2abc894bf2552ac5f4f24776c41aa3fc00368d2b15f23f17714d440a3dba92ab
 SHA512:
-  metadata.gz: c041761b8b59888857aa450c69b051d97c3f44021c9ca00bbeb90a45cecd199f06789e65129b97923668440531e3cfa3884dcdc50eb3df51735c696c0ca70113
-  data.tar.gz: 3446e2643304cd1152612e7695821a4c26765134a8463aae77539a0d07580360f3c71b7495a12d727949d69ce29056ace5db1555572d2a204f831e07644ad586
+  metadata.gz: 8dea12da4cedebbb131c12940b00749f0bbaeae85a333de4fe3cf09687e2019faf5f3a1d57dbbdc1440577e62392d02d1cacc66df0ab766c1661030ce9e34d56
+  data.tar.gz: 327df61aabf9f0a680243cb0870a9df97f2be3b25d4b64a3ede13308c13f2e2a465818f63157c3b53f3c4e92f9c6f802bfcf157feb5264131cae313d82fe6e6a

data/README.md

@@ -1,8 +1,6 @@
 # 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
+A simple dsl for defining rest service consumers in applications.  Mostly intended for test framework use.
 
 ## Installation
 
@@ -22,7 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a service class
+```ruby
+# some_dir/postman_echo.rb
+class PostmanEcho < RestDSL::ServiceBase
+  self.service_name = '' # Postman echo has no service name in its url
+
+  rest_call(:get, :echo, 'get')
+  rest_call(:post, :echo, 'post')
+  rest_call(:get, :auth, 'basic-auth')
+end
+```
+and an associated yaml file
+Note: Uses symbolized keys
+```yml
+# some_dir/postman_echo.yml
+:postman_echo_prod: # The name of my environment
+  :credentials:
+    :user: 'some_user_name'
+    :password: 'some_password'
+  :headers:
+    :some_header: 'foo' 
+```
+
+Make calls to your hearts content
+```ruby
+PostmanEcho.environment = :postman_echo_prod
+PostmanEcho.get_echo(params: {word: 'cow'})
+```
+
+All services are defined as singletons, if you truly need more than one instance for any reason, 
+you can always just dup it into a new constant.  See the specs for more advanced use until I get a chance to write up
+more documentation.
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/castone22/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.
 
 ## License
 

data/lib/rest_dsl/dsl.rb

@@ -0,0 +1,53 @@
+require 'json'
+require 'psych'
+
+module RestDSL
+
+  ##
+  # A collection of DSL extensions for use with various worlds to allow the use of some simpler
+  # dsl language in them.
+  #
+  # For rspec, in spec helper add config.extend RestDSL::DSLExtensions::<<extension>>
+  # In cucumber World(RestDSL::DSLExtensions::<<extension>>)
+  # Each extension can also be extended onto a class like normal to use it in that class
+  module DSLExtensions
+
+    ##
+    # Adds a DSL method for parsing information from a file, parser list can be overridden by setting
+    # @file_parsers.  If no parser is designed, for the file extension, loads the file as plain text
+    module FromFile
+
+      def self.extended(clazz)
+        clazz.instance_eval do
+          @file_parsers = {
+            %w[.json] => JSON,
+            %w[.yml .yaml] => Psych
+          }
+        end
+      end
+
+      def self.included(clazz)
+        clazz.instance_eval do
+          @file_parsers = {
+            %w[.json] => JSON,
+            %w[.yml .yaml] => Psych
+          }
+        end
+      end
+
+      def from_file(file_name)
+        parser = @file_parsers.find{|key, _| key.any? {|file_type| file_name.include? file_type}}[1]
+        result = if parser.eql?(Psych)
+                   parser.load_file(file_name)
+                 else # Most non-yaml parsers in ruby work like the json one so lets make it be the default.
+                   parser.parse(File.read(file_name))
+                 end
+        result ||= File.read(file_name)
+        result
+      rescue Errno::ENOENT => e
+        e.message << " relative to directory #{Dir.pwd}"
+        raise e
+      end
+    end
+  end
+end

data/lib/rest_dsl/version.rb

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

data/lib/rest_dsl.rb

@@ -1,5 +1,6 @@
 require_relative 'rest_dsl/version'
 require_relative 'rest_dsl/errors'
+require_relative 'rest_dsl/dsl'
 require 'psych'
 require 'json'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Luke Ridge
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - bin/setup
 - lib/rest_dsl.rb
 - lib/rest_dsl/client.rb
+- lib/rest_dsl/dsl.rb
 - lib/rest_dsl/errors.rb
 - lib/rest_dsl/service_base.rb
 - lib/rest_dsl/version.rb