endo 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a6e0eb3c683feb92b2e6b18a1a76ff6354a99e3
-  data.tar.gz: 2f97c729f144198dc2cb4d840415c746ac19ae83
+  metadata.gz: ac22efa794a76374a866f7c8f19ee7b7a261efda
+  data.tar.gz: 25f3b904a025040605012eb92327951ea8b87310
 SHA512:
-  metadata.gz: c79bbe2c0263bb186da2dfc9f603d97fae2e7db20de7a5185508fdc2dc389b393ac8da50422c71eefcac213db2da59177853aafcf6d5d1f5d39989c4d3671e82
-  data.tar.gz: 9c1520a0698c7191fdb64e05a0549f2fafee9d570a8639084d0048efaa16327bef551429685c156f872dd936f769b084d2844129ca389fce1975ad4b5a5b0854
+  metadata.gz: 727908b09dfa7314bd86b96ed4a6afda60dede68beb0de41f0bd9bb715850a9979f74a72835211dcf537c0705271f861459f8370c6e83a645d40ce361ad32603
+  data.tar.gz: 5f501ccbfc7ec6f91a07d480cef5f120dfde0bc9b47c0d33325af782b213a6f6254473295c3f1d7ebb6512c7a953d6378ceab0e6ad7f24e3b95dabde1b126a6c

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/Documentation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - "db/migrate/*.rb"
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+AllCops:
+  TargetRubyVersion: 2.2

data/.rubocop_todo.yml

@@ -0,0 +1,270 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-02 14:46:30 +0900 using RuboCop version 0.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AlignWith, SupportedStyles, AutoCorrect.
+# SupportedStyles: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 40
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 149
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 3
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 127
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 1
+Style/AsciiComments:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, IndentOneStep, IndentationWidth.
+# SupportedStyles: case, end
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/DeprecatedHashMethods:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 10
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/endo.rb'
+    - 'lib/endo/cli.rb'
+    - 'lib/endo/core.rb'
+    - 'lib/endo/error/http_error.rb'
+    - 'lib/endo/error/validation_error.rb'
+    - 'lib/endo/expectation_target.rb'
+    - 'lib/endo/matchers.rb'
+    - 'lib/endo/matchers/base_matcher.rb'
+    - 'lib/endo/matchers/eq.rb'
+    - 'lib/endo/matchers/include.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/ElseAlignment:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'lib/endo/expectation_target.rb'
+    - 'lib/endo/matchers.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'lib/endo/cli.rb'
+    - 'lib/endo/core.rb'
+    - 'lib/endo/matchers/eq.rb'
+    - 'lib/endo/matchers/include.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Style/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/endo/core.rb'
+    - 'lib/endo/error/http_error.rb'
+    - 'lib/endo/error/validation_error.rb'
+    - 'lib/endo/expectation_target.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/endo/matchers/include.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: normal, rails
+Style/IndentationConsistency:
+  Exclude:
+    - 'lib/endo/matchers/eq.rb'
+    - 'lib/endo/matchers/include.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/LeadingCommentSpace:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/endo/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'endo.gemspec'
+
+# Offense count: 5
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantParentheses:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: space, no_space
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpaceAroundKeyword:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/SpaceAroundOperators:
+  Exclude:
+    - 'lib/endo/core.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 26
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Style/TrailingBlankLines:
+  Exclude:
+    - 'Rakefile'
+    - 'bin/endo'
+    - 'lib/endo.rb'
+    - 'lib/endo/core.rb'
+    - 'lib/endo/error.rb'
+    - 'lib/endo/error/http_error.rb'
+    - 'lib/endo/error/validation_error.rb'
+    - 'lib/endo/expectation_target.rb'
+    - 'lib/endo/matchers.rb'
+    - 'lib/endo/matchers/base_matcher.rb'
+    - 'lib/endo/matchers/eq.rb'
+    - 'lib/endo/matchers/include.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'endo.gemspec'

data/README.md

@@ -1,37 +1,38 @@
 # endo
 
-This is a tool for testing api endpoints.
-In development state.
+This is a tool for testing json api endpoints.
 
 # Usage
 
 Write endo file.
-ex. endo/sample.endo
+ex. endo/sample.rb
 
 ```ruby
-set :base_url, 'http://endo-sample.maruware.com'
+base_url 'http://localhost:3000'
+basic_auth 'user', 'pass'
 
 get '/articles' do
-  expect(body: ->{ at(0)[:title] }).to eq 'good'
+  expect(header: 'Content-Type').to eq 'application/json; charset=utf-8'
+end
+
+post '/articles.json' do
+  param 'article[title]', 'hello'
+  param 'article[content]', 'Hello, world!'
 end
 
 get '/articles/:article_id' do
   param :article_id do
-    from :get, '/articles', ->{ first[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
 
-  expect(header: 'Content-Type').to eq 'application/json; charset=utf-8'
-end
-
-post '/articless' do
-  param :title, 'hello'
-  param :text, 'Hello, world!'
+  expect(header: 'Content-Type').to eq 'application/json'
+  expect(body: -> { self[:title] }).to eq 'hello'
 end
 ```
 
 Exec endo command.
 
-![2016-03-07 21 24 08](https://cloud.githubusercontent.com/assets/1129887/13569450/7d9a796a-e4ab-11e5-9ab0-e52eef36ea0f.png)
+![ss_ 2016-05-02 16 12 58](https://cloud.githubusercontent.com/assets/1129887/14948974/f20798cc-1080-11e6-8b0d-90679c26b44e.png)
 
 ## Installation
 
@@ -51,4 +52,4 @@ Or install it yourself as:
 
 ```bash
 $ gem install endo
-```
+```

data/endo/sample.rb

@@ -1,4 +1,4 @@
-set :base_url, 'http://localhost:3000'
+base_url 'http://localhost:3000'
 basic_auth 'user', 'pass'
 
 get '/articles' do
@@ -12,16 +12,16 @@ end
 
 get '/articles/:article_id' do
   param :article_id do
-    from :post, '/articles.json', ->{ self[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
 
   expect(header: 'Content-Type').to eq 'application/json; charset=utf-8'
-  expect(body: ->{ self[:title] }).to eq 'hello'
+  expect(body: -> { self[:title] }).to eq 'hello'
 end
 
 patch '/articles/:article_id.json' do
   param :article_id do
-    from :post, '/articles.json', ->{ self[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
 
   param 'article[title]', 'こんにちは'
@@ -29,15 +29,15 @@ end
 
 get '/articles/:article_id' do
   param :article_id do
-    from :post, '/articles.json', ->{ self[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
 
-  expect(body: ->{ self[:title] }).to eq 'こんにちは'
+  expect(body: -> { self[:title] }).to eq 'こんにちは'
 end
 
 put '/articles/:article_id.json' do
   param :article_id do
-    from :post, '/articles.json', ->{ self[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
 
   param 'article[title]', 'bonjour'
@@ -45,6 +45,6 @@ end
 
 delete '/articles/:article_id.json' do
   param :article_id do
-    from :post, '/articles.json', ->{ self[:id] }
+    from :post, '/articles.json', -> { self[:id] }
   end
-end
+end

data/lib/endo/cli.rb

@@ -5,8 +5,8 @@ module Endo
   class CLI < Thor
     default_command :exec
 
-    desc "exec usage", "exec desc"
-    def exec(endo_file=nil)
+    desc 'exec usage', 'exec desc'
+    def exec(endo_file = nil)
       if endo_file.nil?
         Dir.glob('endo/*.rb').each do |f|
           exec_proc(f)
@@ -16,12 +16,13 @@ module Endo
       end
     end
 
-    desc "version", "Print version"
+    desc 'version', 'Print version'
     def version
       puts "endo version #{Endo::VERSION}"
     end
 
     private
+
     def exec_proc(file_path)
       executor = Endo::Core.new
       executor.instance_eval File.read(file_path)

data/lib/endo/core.rb

@@ -8,16 +8,10 @@ module Endo
     include Endo::Matchers
 
     def initialize
-      @props = {}
       @responses = {}
       @expect_alls = {}
     end
 
-    def set(key, val)
-      #TODO: validate key
-      @props[key] = val
-    end
-
     def get(endpoint, &block)
       request(endpoint, :get, &block)
     end
@@ -38,43 +32,39 @@ module Endo
       request(endpoint, :put, &block)
     end
 
-    #TODO: 制限
-    def param(key, val=nil, &block)
-      unless (!val.nil?) ^ (!block.nil?) # Only either one
-        raise ArgumentError.new('DupValue')
-      end
-
-      @params[key.to_s] = if val
-        val
-      else
-        block.call
-      end
+    # TODO: 制限
+    def param(key, val = nil)
+      raise ArgumentError, 'DupValue' unless !val.nil? ^ block_given?
 
+      @params[key.to_s] = val ? val : yield
     end
 
-    #TODO: Limit scope
-    def from(method, endpoint, lmd=nil, &block)
+    # TODO: Limit scope
+    def from(method, endpoint, lmd = nil, &_block)
       key = build_response_key(method, endpoint)
-      unless @responses.has_key? key
-        raise RuntimeError.new("NotFoundKey [#{key}]")
-      end
+      raise RuntimeError "NotFoundKey [#{key}]" unless @responses.key? key
 
       res = @responses[key]
-      val = if lmd
-        res.instance_exec &lmd
-      elsif block
-        block.call(res)
+      val = nil
+      if !lmd.nil?
+        val = res.instance_exec(&lmd)
+      elsif block_given?
+        val = yield res
       else
-        raise ArgumentError.new('UndefinedBlock')
+        raise ArgumentError, 'UndefinedBlock'
       end
 
       unless val.is_a?(String) || val.is_a?(Integer) || val.is_a?(Numeric)
-        raise RuntimeError.new('BadValueType')
+        raise 'BadValueType'
       end
 
       val
     end
 
+    def base_url(url)
+      @base_url = url
+    end
+
     def basic_auth(user, pass)
       @basic_auth = {
         user: user, pass: pass
@@ -82,27 +72,22 @@ module Endo
     end
 
     private
-    def request(endpoint, method, &block)
-      org_endpoint = endpoint.clone
 
+    def request(endpoint, method, &_block)
       @params = {}
       @expects = []
-      block.call if block
+      yield if block_given?
 
       endpoint = apply_pattern_vars(endpoint, @params)
-
-      url = @props[:base_url] + endpoint
+      url = @base_url + endpoint
 
       begin
-        t_start = Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }
-        res = http_request(url, @params, method: method)
-        t_end = Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }
-
-        res_data = parse_body_json(res)
-        @responses[build_response_key(method, endpoint)] = res_data
+        res, time_ms = request_with_timer(url, method, @params)
         validate_expects(res) unless @expect_alls.empty? && @expects.empty?
-        message = "🍺 #{method.upcase} #{endpoint} [#{t_end-t_start}ms]"
-      rescue Error::HttpError=>e
+        @responses[build_response_key(method, endpoint)] = parse_body_json(res)
+
+        message = "🍺 #{method.upcase} #{endpoint} [#{time_ms}ms]"
+      rescue Error::HttpError => e
         message = "💩 #{method.upcase} #{endpoint} [code: #{e.code}]".red
         exit 1
       rescue Error::ValidationError => e
@@ -110,7 +95,6 @@ module Endo
       ensure
         puts message
       end
-
     end
 
     def apply_pattern_vars(endpoint, params)
@@ -118,9 +102,7 @@ module Endo
       if patterns.any?
         patterns.flatten!
         patterns.each do |pattern|
-          unless params.has_key? pattern
-            raise RuntimeError.new("NotFoundPattern #{pattern}")
-          end
+          raise "NotFoundPattern #{pattern}" unless params.key? pattern
 
           endpoint.sub!(/:#{pattern}/, params[pattern].to_s)
         end
@@ -132,10 +114,28 @@ module Endo
       endpoint
     end
 
+    def request_with_timer(url, method, params)
+      t_start = Time.now.instance_eval { to_i * 1000 + (usec / 1000) }
+      res = http_request(url, params, method: method)
+      t_end = Time.now.instance_eval { to_i * 1000 + (usec / 1000) }
+
+      [res, t_end - t_start]
+    end
+
     def http_request(url, params, method: :get)
       uri = URI.parse url
+      req = create_request_each_method(uri, params, method)
+
+      req.basic_auth @basic_auth[:user], @basic_auth[:pass] if @basic_auth
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+      raise Error::HttpError.new("HTTP Bad Status[#{res.code}] #{res.body}", res.code, res.body) unless /^20[0-8]$/ =~ res.code
+
+      res
+    end
 
-      req = case method
+    def create_request_each_method(uri, params, method)
+      case method
       when :get
         uri.query = URI.encode_www_form(params)
         Net::HTTP::Get.new uri
@@ -145,23 +145,14 @@ module Endo
         req
       when :delete
         uri.query = URI.encode_www_form(params)
-        req = Net::HTTP::Delete.new uri
+        Net::HTTP::Delete.new uri
       when :patch
         uri.query = URI.encode_www_form(params)
-        req = Net::HTTP::Patch.new uri
+        Net::HTTP::Patch.new uri
       when :put
         uri.query = URI.encode_www_form(params)
-        req = Net::HTTP::Put.new uri
+        Net::HTTP::Put.new uri
       end
-
-      if @basic_auth
-        req.basic_auth @basic_auth[:user], @basic_auth[:pass]
-      end
-
-      res = Net::HTTP.start(uri.host, uri.port) {|http| http.request req }
-      raise Error::HttpError.new("HTTP Bad Status[#{res.code}] #{res.body}", res.code, res.body) unless /^20[0-8]$/ =~ res.code
-
-      return res
     end
 
     def parse_body_json(res)
@@ -173,15 +164,15 @@ module Endo
     end
 
     def expect(header: nil, body: nil)
-      expectation = if header
-        ExpectationTarget.new(:header, header)
-      elsif(body)
-        ExpectationTarget.new(:body, body)
+      if header
+        expectation = ExpectationTarget.new(:header, header)
+      elsif body
+        expectation = ExpectationTarget.new(:body, body)
       else
         raise 'TODO'
       end
       @expects << expectation
-      return expectation
+      expectation
     end
 
     def validate_expects(res)
@@ -191,6 +182,5 @@ module Endo
         end
       end
     end
-
   end
-end
+end

data/lib/endo/error/http_error.rb

@@ -1,4 +1,3 @@
-
 module Endo
   module Error
     class HttpError < StandardError
@@ -9,7 +8,6 @@ module Endo
         @code = code
         @body = body
       end
-
     end
   end
-end
+end

data/lib/endo/error/validation_error.rb

@@ -9,7 +9,6 @@ module Endo
         @expected = expected
         @actual = actual
       end
-
     end
   end
-end
+end

data/lib/endo/version.rb

@@ -1,3 +1,3 @@
 module Endo
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: endo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - maruware
@@ -89,6 +89,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - README.md
 - Rakefile