herdic 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef268be629514bf377f23553f43f248b81b4be1d
-  data.tar.gz: 5650ca841a9f2755592bd60175970edf92bd7ace
+  metadata.gz: e293ef971ac5b07472c541fa6b6348183cdaf105
+  data.tar.gz: 2f0904dcdc7ecf20317d44e41434615ad8a856fb
 SHA512:
-  metadata.gz: f43967abd1f488067ab213c43401b1e5bd2e66fd85f53c87965c6359e19133632780a52588f71af2fb37c945b2a8efc767ec4334e2ad3660afcdf04f1cb90ed8
-  data.tar.gz: fe1f500659727cb2fb901720673c467eb8dc82aa3c956af6212315e4d4f2ee3b5c3d8396f5a8ba500ef42175cc6cb1abb7ac7018a76bc8b9dede286d09cd1329
+  metadata.gz: e7a737516853ed8aca699b0b5ccdf4a86235c67aa4c7eb7f0d5d80911bd23df7f246ae4d4c0edd52338296001f1c10363d17197d6d6a8dbe6b0f5bbd75a47aad
+  data.tar.gz: 68317f866a290521f3b8a5075aaf3712069a19ab2f9e63bd53f9f737a4b997ee505beb18ff10402fd42b132206c03de98b7c6d38dd129a5ab2495851e3d4cbe0

data/README.md

@@ -4,6 +4,88 @@ Herdic
 **Herdic is a command line HTTP client intended to create and test API documentation with ease.**
 
 
+Installation
+------------
+
+```sh
+$ gem install herdic
+```
+
+Or add the gem to your Gemfile.
+
+```ruby
+gem 'herdic'
+```
+
+
+Synopsis
+--------
+
+```
+herdic [-e] [-c config.yaml] [--use-ssl] path/to/spec.yaml
+```
+
+| Option           | Description                                   |
+| ---------------- | --------------------------------------------- |
+| `-e`             | Edit request file in vim (default) before run |
+| `-c config.yaml` | Specify absolute path of herdic.yaml          |
+| `--use-ssl`      | Use `Net::HTTP` with flag `use_ssl = true`    |
+
+
+Sample
+------
+
+### Config
+
+```yaml
+# herdic.yaml
+api_base: http://localhost:3000/user_v1
+
+user_account:
+  email:    user+1@example.com
+  password: password
+```
+
+### Specs
+
+```yaml
+# sessions/create.yaml
+
+- title:    Signin as user
+  method:   post
+  endpoint: <%= config['api_base'] %>/user_account/session
+
+  body:
+    user_account:
+      email:    <%= config['user_account']['email'] %>
+      password: <%= config['user_account']['password'] %>
+
+  register:
+    user_account_access_token: user_account.access_token
+```
+
+```yaml
+# user_bases/show.yaml
+
+- include: ../sessions/create.yaml
+
+- title:    Show user basis
+  method:   get
+  endpoint: <%= config['api_base'] %>/user_basis
+
+  header:
+    X-Access-Token: <%= registry['user_account_access_token'] %>
+```
+
+### Run
+
+```sh
+$ herdic user_bases/show.yaml
+```
+
+![](./preview.gif)
+
+
 License
 -------
 

data/bin/herdic

@@ -3,7 +3,7 @@
 require 'herdic'
 
 
-options = ARGV.getopts 'e', 'c:', 'use-ssl', 'html'
+options = ARGV.getopts 'e', 'c:', 'use-ssl'
 file = ARGV[0]
 
 raise 'No file given' if !file || file.empty?

data/lib/herdic.rb

@@ -22,8 +22,8 @@ module Herdic
       @pwd               = File.expand_path '.'
       @herdic_path       = File.expand_path '~/.herdic'
       @store_path        = File.join @herdic_path, 'store'
-      @edit_request_file = File.join @herdic_path, 'edit_request.yml'
-      @config_filename   = 'herdic.yml'
+      @edit_request_file = File.join @herdic_path, 'edit_request.yaml'
+      @config_filename   = 'herdic.yaml'
     end
 
   end

data/lib/herdic/client.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext'
 require 'erb'
+require 'fileutils'
 require 'json'
 require 'net/http'
 require 'open-uri'
@@ -16,16 +17,16 @@ module Herdic
     def initialize(file, options)
       @file, @options = file, options
 
-      @config_file = @options['c'] || Util.find_files_upward(Herdic.config_filename, Herdic.pwd, 1)[0]
       @context = binding
 
-      @store = Store.new @config_file
-      @registry = @store.data
+      @config_file = @options['c'] || Util.find_files_upward(Herdic.config_filename, Herdic.pwd, 1)[0]
+      load_config @config_file if @config_file
 
       @printer = Printer.new @options
+      @printer.start_message @config_file
 
-      load_config @config_file if @config_file
-      load_yaml
+      @store = Store.new @config_file
+      @registry = @store.data
     end
 
     def load_config(file)
@@ -38,24 +39,15 @@ module Herdic
       @config = Psych.load @config
     end
 
-    def load_yaml
-      @specs = Loader.new(@file).specs
-
+    def run_all
       if @options['e']
-        File.open(Herdic.edit_request_file, 'w+') do |f|
-          f.write Psych.dump(@specs)
-        end
-
+        FileUtils.cp @file, Herdic.edit_request_file
         system "$EDITOR '%s'" % Herdic.edit_request_file
 
-        File.open(Herdic.edit_request_file, 'r') do |f|
-          @specs = Psych.load f.read
-        end
+        @specs = Loader.new Herdic.edit_request_file, @file
+      else
+        @specs = Loader.new @file
       end
-    end
-
-    def run_all
-      @printer.start_message @specs
 
       @specs.each do |spec|
         # FIXME: figure out better way

data/lib/herdic/loader.rb

@@ -4,34 +4,39 @@ require 'psych'
 module Herdic
   class Loader
 
-    attr_accessor :specs
+    include Enumerable
 
-    def initialize(file)
-      @specs = []
-
-      load file
+    def initialize(file, original = nil)
+      @file, @original = file, original
     end
 
-    def load(file, included_from = nil)
+    def load(file, original, included_from = nil)
       file = File.expand_path file, included_from
 
+      specs = ''
+
       File.open(file, 'r') do |f|
-        @_specs = f.read
+        specs = f.read
       end
 
-      @_specs = Psych.load @_specs
+      specs = Psych.load specs
 
-      @_specs.each do |spec|
-        spec['file'] = file
+      specs.each do |spec|
+        spec['file'] = original || file
 
         if spec['include']
-          load spec['include'], File.dirname(file)
+          load spec['include'], nil, File.dirname(spec['file'])
         else
-          @specs << spec
+          @block.call spec
         end
       end
+    end
+
+    def each(&block)
+      return unless block
 
-      @_specs = nil
+      @block = block
+      load @file, @original
     end
 
   end

data/lib/herdic/printer.rb

@@ -9,8 +9,12 @@ module Herdic
       @options = options
     end
 
-    def start_message(specs)
-      puts 'Running %d spec(s)' % specs.size
+    def start_message(config_file = nil)
+      if config_file
+        puts "Starting Herdic (#{config_file})"
+      else
+        puts 'Starting Herdic'
+      end
     end
 
     def title(meta)
@@ -93,4 +97,3 @@ module Herdic
 
   end
 end
-

data/lib/herdic/version.rb

@@ -2,7 +2,7 @@ module Herdic
 
   MAJOR    = 1
   MINOR    = 0
-  REVISION = 1
+  REVISION = 2
 
   VERSION = [MAJOR, MINOR, REVISION].compact.join '.'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: herdic
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Yuki Iwanaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -91,12 +91,12 @@ files:
 - herdic.gemspec
 - lib/herdic.rb
 - lib/herdic/client.rb
-- lib/herdic/color.rb
 - lib/herdic/loader.rb
 - lib/herdic/printer.rb
 - lib/herdic/store.rb
 - lib/herdic/util.rb
 - lib/herdic/version.rb
+- preview.gif
 homepage: https://github.com/creasty/herdic
 licenses:
 - MIT

data/lib/herdic/color.rb

@@ -1 +0,0 @@
-class Her