stubify 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3024ecac437551c37cfd1b61ec9432ae25a95d68
-  data.tar.gz: 1ea224476a63df693848a3d76b80b65bbf99c758
+  metadata.gz: 6cdf3c98837d99ac32a3638b51ada2857535b84a
+  data.tar.gz: b42efacd614f1adad54dfeecfbc93077509d9f8c
 SHA512:
-  metadata.gz: 27a60208d4c7f65d600da4f6e6fc93d6d38f69de24bc298249ad657e30bc976ac6ec8c051143a64cf35cbc8175cd447979c101892230c430fb8d415d23222cdb
-  data.tar.gz: 0e7cf755418ed007539e1b079d9f8bde8aaa8df20e5f61292984f43b4a6b8fc22222a65fa44db4aba4e73891bbb849948b10e7ad120b08bda62684582bd4fe9f
+  metadata.gz: e24d36514b3f6f23e2c054300ae8fadfa3575e16a59c841083bff1402b37419cc9177008c12b3641c6d330114dff32e444b0c081cc15edfe750b43a579f0c22c
+  data.tar.gz: ac125c537db1958ddcfcfa42b4980cb0bab4d4e40e82e77eb871be40dfb87621b6b1662e90ff13598b8bfb3ffee065ed9fca5acd489b59649eca0745f5817852

data/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Carlos Vidal
+
+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,71 @@
+# stubify
+
+[![Twitter: @carlostify](https://img.shields.io/badge/contact-@carlostify-blue.svg?style=flat)](https://twitter.com/carlostify)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/nakiostudio/xcov/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/stubify.svg?style=flat)](http://rubygems.org/gems/stubify)
+
+**stubify** allows you to stub real environments without really doing anything. It runs a [Sinatra](https://github.com/sinatra/sinatra)
+application locally and, given a host, it forwards all the calls received caching the real responses, that way, next time the local
+environment receives a request the cached response is returned.
+
+## Example
+
+By running the gem with the following command:
+```bash
+stubify server --host https://easy-peasy.io --directory fixtures
+```
+
+It will create a local environment with address `http://localhost:4567`. Every request received will be recreated against the host
+provided, therefore a request to `http://localhost:4567/rest_api/user/32325` will return whatever `https://easy-peasy.io/rest_api/user/32325`
+returns and, in addition, that response will be cached in the directory `fixtures`.
+
+Next time a request to `http://localhost:4567/rest_api/user/32325` is made the cached payload will be returned.
+
+## Features
+
+* Accepts `GET`, `POST`, `PUT` and `DELETE` requests.
+* HTTP headers, query parameters and request bodies are taken into account.
+
+## Roadmap
+
+This is a summary of the ideas which implementation is pending:
+
+* Whitelisting of endpoints to avoid caching.
+
+## Installation
+
+```
+sudo gem install stubify
+```
+
+## Usage
+
+```
+stubify server --host https://real-host.com --directory path_to_cached_response
+
+ACTIONS:
+
+    server [options]
+
+OPTIONS:
+
+  --host STRING
+      Host the requests will be redirected to. i.e. https://easy-peasy.io
+
+  --directory DIR
+      Path where fixtures will be stored. i.e. fixtures/
+
+  --port STRING
+      Port the local environment will listen to. Default is 4567
+
+  --verbose
+      Increases the amount of information logged
+```
+
+## Contributors
+
+[![nakiostudio](https://avatars2.githubusercontent.com/u/1814571?v=3&s=50)](https://github.com/nakiostudio)
+
+## License
+
+This project is licensed under the terms of the MIT license. See the LICENSE file.

data/lib/stubify.rb

@@ -12,14 +12,34 @@ module Stubify
       program :name, 'stubify'
       program :version, Stubify::VERSION
       program :description, Stubify::DESCRIPTION
+      program :help, 'Author', 'Carlos Vidal <nakioparkour@gmail.com>'
 
       command :server do |c|
-        c.syntax = 'server'
-        c.description = ''
-        c.option '--directory STRING', String, 'Path where fixtures will be stored. i.e. fixtures/'
+        c.syntax = 'server [options]'
+        c.description = 'Runs a local environment that will forward the requests received to the host provided. Responses will be cached'
         c.option '--host STRING', String, 'Host the requests will be redirected to. i.e. https://easy-peasy.io'
+        c.option '--directory DIR', String, 'Path where fixtures will be stored. i.e. fixtures/'
+        c.option '--port STRING', String, 'Port the local environment will listen to. Default is 4567'
+        c.option '--verbose', 'Increases the amount of information logged'
         c.action do |args, options|
+          # Ensure host is set
+          if options.host.nil?
+            raise 'Host must be provided. Run help command for more details'
+          end
+
+          # Default options
+          options.default \
+            port: '4567',
+            directory: 'fixtures',
+            verbose: false
+
+          # Set env variables
+          ENV['PORT'] = options.port
+
+          # Set options global attr
           Stubify.options = options
+
+          # Launch Sinatra app
           require 'stubify/server'
         end
       end

data/lib/stubify/server.rb

@@ -6,7 +6,8 @@ module Stubify
   class Server < Sinatra::Base
 
     set :app_file, __FILE__
-    set :run, Proc.new { true }
+    set :run, true
+    set :quiet, !Stubify.options.verbose
 
     if run?
       puts 'Launching Sinatra app...'

data/lib/stubify/version.rb

@@ -1,6 +1,6 @@
 module Stubify
 
-    VERSION = "0.1.0"
-    DESCRIPTION = "The program description"
+    VERSION = '0.1.1'
+    DESCRIPTION = 'Create stub environments the easy way'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stubify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Carlos Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -86,7 +86,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The program description
+description: Create stub environments the easy way
 email:
 - nakioparkour@gmail.com
 executables:
@@ -124,5 +124,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: The program description
+summary: Create stub environments the easy way
 test_files: []