herdic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db085b78a8df105d3eb982a5b834d7304c1a8260
+  data.tar.gz: 5c30a1b5ec2a9f5eaa5d40f011fd84276942392a
+SHA512:
+  metadata.gz: 2ddd65a6cbc49daa112c8cb94afd8be6b94aefd1d6b3788f3e8ea4615a9eea5f409f9a094751a5e964e52a8758410e9f077050332bf14f41099639e44f913f32
+  data.tar.gz: 5d2cfe473cbef993e072f529a14bd00cfcf39569a7bf3e4f2de55bea794adb219ad5095806c56cdd9a1c01f6ea6f4a02d33a2b113f7b542e82c4b19fbc4fdc38

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Iwanaga
+
+MIT License
+
+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,11 @@
+Herdic
+======
+
+**Herdic is a command line HTTP client intended to create and test API documentation with ease.**
+
+
+License
+-------
+
+This project is copyright by [Creasty](http://www.creasty.com), released under the MIT lisence.  
+See `LICENSE` file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/bin/herdic

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'herdic'
+
+
+options = ARGV.getopts 'e', 'c:', 'use-ssl', 'html'
+file = ARGV[0]
+
+raise 'No file given' if !file || file.empty?
+
+Herdic.setup
+
+client = Herdic::Client.new file, options
+client.run_all

data/herdic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'herdic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'herdic'
+  spec.version       = Herdic::VERSION
+  spec.authors       = ['Yuki Iwanaga']
+  spec.email         = ['yuki@creasty.com']
+  spec.summary       = 'A command line HTTP client intended to create and test API documentation with ease'
+  spec.description   = 'A command line HTTP client intended to create and test API documentation with ease'
+  spec.homepage      = 'https://github.com/creasty/herdic'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.1', '>= 3.2'
+  spec.add_dependency 'awesome_print', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+end

data/lib/herdic.rb

@@ -0,0 +1,60 @@
+require 'herdic/version'
+require 'herdic/util'
+require 'herdic/store'
+require 'herdic/loader'
+require 'herdic/printer'
+require 'herdic/client'
+
+require 'fileutils'
+
+
+module Herdic
+
+  class Configuration
+
+    attr_accessor :pwd,
+      :herdic_path,
+      :store_path,
+      :edit_request_file,
+      :config_filename
+
+    def initialize
+      @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   = 'api_config.yml'
+    end
+
+  end
+
+  class << self
+
+    def setup
+      @config ||= Configuration.new
+
+      yield @config if block_given?
+
+      ensure_directory!
+    end
+
+    def ensure_directory!
+      FileUtils.mkdir_p self.herdic_path
+      FileUtils.mkdir_p self.store_path
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @config.respond_to? method_name
+        @config.send method_name, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name, include_private = false)
+      @config.respond_to? method_name
+    end
+
+  end
+
+end

data/lib/herdic/client.rb

@@ -0,0 +1,133 @@
+require 'active_support/core_ext'
+require 'erb'
+require 'json'
+require 'net/http'
+require 'open-uri'
+require 'optparse'
+require 'psych'
+require 'uri'
+
+
+module Herdic
+  class Client
+
+    attr_reader :registry, :config
+
+    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
+
+      @printer = Printer.new @options
+
+      load_config @config_file if @config_file
+      load_yaml
+    end
+
+    def load_config(file)
+      @config = {}
+
+      File.open(file, 'r') do |f|
+        @config = ERB.new(f.read).result @context
+      end
+
+      @config = Psych.load @config
+    end
+
+    def load_yaml
+      @specs = Loader.new(@file).specs
+
+      if @options['e']
+        File.open(Herdic.edit_request_file, 'w+') do |f|
+          f.write Psych.dump(@specs)
+        end
+
+        system "$EDITOR '%s'" % Herdic.edit_request_file
+
+        File.open(Herdic.edit_request_file, 'r') do |f|
+          @specs = Psych.load f.read
+        end
+      end
+    end
+
+    def run_all
+      @printer.start_message @specs
+
+      @specs.each do |spec|
+        # FIXME: figure out better way
+        spec = Psych.dump spec
+        spec = ERB.new(spec).result @context
+        spec = Psych.load spec
+
+        run spec
+      end
+
+      @store.save
+    end
+
+    private def run(spec)
+      setup_spec spec
+
+      uri = URI.parse @meta['endpoint']
+      http = Net::HTTP.new uri.host, uri.port
+      http.use_ssl = @options['use-ssl']
+
+      response = http.start do
+        case @meta['method']
+        when 'GET'
+          uri.query = @body.to_query
+          http.get uri.request_uri, @header
+        when 'POST'
+          http.post uri.request_uri, @body.to_query, @header
+        when 'PATCH'
+          http.patch uri.request_uri, @body.to_query, @header
+        when 'DELETE'
+          http.delete uri.request_uri, @header
+        else
+          raise "Unsupported method: #{@meta['method']}"
+        end
+      end
+
+      body = response.body
+      body = JSON.parse body if 'application/json' == response.content_type
+
+      @printer.title @meta
+      @printer.request @header, @body
+      @printer.response response, body
+
+      register response, body
+    end
+
+    private def setup_spec(spec)
+      @meta     = spec.slice 'title', 'method', 'endpoint'
+      @register = spec['register'] || {}
+      @header  = spec['header'] || {}
+      @body     = spec['body'] || {}
+
+      @meta['method'].upcase!
+      @header = @header.map { |k, v| [k, v.to_s] }.to_h
+    end
+
+    private def register(response, body)
+      return unless 'application/json' == response.content_type
+
+      @register.each do |name, path|
+        next if path.empty?
+
+        val = body
+
+        path.to_s.split('.').each do |key|
+          key = key.to_i if key === /\A\d+\z/
+          val = val.try :[], key
+        end
+
+        @registry[name] = val
+      end
+    end
+
+  end
+end

data/lib/herdic/loader.rb

@@ -0,0 +1,38 @@
+require 'psych'
+
+
+module Herdic
+  class Loader
+
+    attr_accessor :specs
+
+    def initialize(file)
+      @specs = []
+
+      load file
+    end
+
+    def load(file, included_from = nil)
+      file = File.expand_path file, included_from
+
+      File.open(file, 'r') do |f|
+        @_specs = f.read
+      end
+
+      @_specs = Psych.load @_specs
+
+      @_specs.each do |spec|
+        spec['file'] = file
+
+        if spec['include']
+          load spec['include'], File.dirname(file)
+        else
+          @specs << spec
+        end
+      end
+
+      @_specs = nil
+    end
+
+  end
+end

data/lib/herdic/printer.rb

@@ -0,0 +1,84 @@
+require 'ap'
+
+
+module Herdic
+  class Printer
+
+    def initialize(options)
+      @options = options
+    end
+
+    def start_message(specs)
+      puts 'Running %d spec(s)' % specs.size
+    end
+
+    def title(meta)
+      puts "\n\n"
+      hr rule: '=', color: :green
+
+      puts [meta['method'].green, meta['endpoint']].join('  ')
+
+      if meta['title']
+        indent = ' ' * meta['method'].size
+        puts [indent, meta['title'].white].join('  ')
+      end
+
+      hr rule: '=', color: :green
+    end
+
+    def subtitle(text)
+      puts
+      puts "==> #{text}".blue
+      puts
+    end
+
+    def request(header, body)
+      subtitle 'Request'
+
+      if header.empty?
+        puts 'no header'.white
+      else
+        print_header header
+      end
+
+      hr
+
+      ap body
+    end
+
+    def response(response, body)
+      subtitle "Response: #{response.code} #{response.message}"
+
+      print_header response.to_hash
+
+      hr
+
+      if body.empty?
+        puts 'no body'.white
+      elsif 'application/json' == response.content_type
+        ap body
+      elsif @options['html']
+        puts body
+      else
+        puts 'N/A'.white
+      end
+    end
+
+    private def print_header(header)
+      max_cols = header.keys.map(&:size).max
+      header.each do |k, v|
+        puts [("%#{max_cols}s" % k).white, v].join ' '
+      end
+    end
+
+    private def hr(rule: '-', color: :black)
+      puts (rule * terminal_cols).send(color)
+    end
+
+    private def terminal_cols
+      @terminal_cols ||= Integer(`tput cols`)
+    end
+
+  end
+end
+

data/lib/herdic/store.rb

@@ -0,0 +1,28 @@
+require 'digest'
+
+
+module Herdic
+  class Store
+
+    attr_reader :data
+
+    def initialize(path = nil)
+      hash = Digest::MD5.hexdigest File.expand_path(path.to_s)
+      @file = File.join Herdic.store_path, hash
+
+      load
+    end
+
+    def load
+      data = nil
+      File.open(@file, 'a+b') { |f| data = f.read }
+      @data = Marshal.load(data) rescue {}
+    end
+
+    def save
+      data = Marshal.dump @data
+      File.open(@file, 'wb') { |f| f.write data }
+    end
+
+  end
+end

data/lib/herdic/util.rb

@@ -0,0 +1,24 @@
+module Herdic
+  module Util
+
+    def self.find_files_upward(filename, base, count = 0)
+      found = []
+
+      while count >= 1 || count < 0
+        file = File.join base, filename
+
+        if File.exists? file
+          found << file
+          count -= 1
+        end
+
+        break if '.' == base
+
+        base = File.dirname base
+      end
+
+      found
+    end
+
+  end
+end

data/lib/herdic/version.rb

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: herdic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuki Iwanaga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: A command line HTTP client intended to create and test API documentation
+  with ease
+email:
+- yuki@creasty.com
+executables:
+- herdic
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/herdic
+- herdic.gemspec
+- lib/herdic.rb
+- lib/herdic/client.rb
+- lib/herdic/loader.rb
+- lib/herdic/printer.rb
+- lib/herdic/store.rb
+- lib/herdic/util.rb
+- lib/herdic/version.rb
+homepage: https://github.com/creasty/herdic
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A command line HTTP client intended to create and test API documentation
+  with ease
+test_files: []