liedetector 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d61795781cd370a2ac0d5aec455ce7ec975809bf
+  data.tar.gz: c2a9cfdc741c5f04a7976c144507d2a18a17aa14
+SHA512:
+  metadata.gz: dbb02fb245886090664c4b78ac42e8f0c73e59d2e750930189608517d3aff88f58aa78d5f636c658af654e949ecfce12ca39f9c56d2c5ad6c0848b56ce9b909e
+  data.tar.gz: d60f6ada6be527870ae719e953683e89bee2845316a3ce7a1e99497a7f30cd5bb4dbb4843b1ce31095fa7d9a489175f30754949aeffeeb5d7b0f0ccc789cdc81

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'trafaret'
+gem 'httpclient'
+gem 'oj'
+gem 'redcarpet'
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    httpclient (2.4.0)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.0)
+    oj (2.9.4)
+    redcarpet (3.1.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    thread_safe (0.3.4)
+    trafaret (1.5.7)
+      activesupport
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httpclient
+  oj
+  redcarpet
+  rspec
+  trafaret

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/liedetector

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+
+require 'liedetector'
+
+
+suite = LieDetector::Suite.new(ARGV[0])
+suite.run

data/lib/liedetector/markdown_runner.rb

@@ -0,0 +1,63 @@
+module LieDetector
+  class MarkdownRunner < Redcarpet::Render::Base
+    def initialize(suite)
+      @suite = suite
+      super()
+    end
+
+    def block_code(code, language)
+      @suite.code_block(code)
+      nil
+    end
+
+    [# block-level calls
+      :block_quote,
+      :block_html, :list, :list_item,
+
+      # span-level calls
+      :autolink, :codespan, :double_emphasis,
+      :emphasis, :underline, :raw_html,
+      :triple_emphasis, :strikethrough,
+      :superscript,
+
+      # footnotes
+      :footnotes, :footnote_def, :footnote_ref,
+
+      # low level rendering
+      # :entity, :normal_text
+    ].each do |method|
+      define_method method do |*args|
+        @suite.push_descriptions args.first
+        nil
+      end
+    end
+
+    def normal_text(text)
+      text
+    end
+
+
+    # Other methods where we don't return only a specific argument
+    def link(link, title, content)
+      @suite.push_descriptions "#{content} (#{link})"
+      nil
+    end
+
+    def image(link, title, content)
+      content &&= content + " "
+      @suite.push_descriptions "#{content}#{link}"
+      nil
+    end
+
+    def paragraph(text)
+      @suite.push_descriptions("\n#{text}\n")
+      nil
+    end
+
+    LEVEL_DOTS = {1 => '=', 2 => '-', 3 => '.'}
+    def header(text, header_level)
+      @suite.push_descriptions("\n#{text}\n#{LEVEL_DOTS[header_level] * text.size}\n")
+      nil
+    end
+  end
+end

data/lib/liedetector/request.rb

@@ -0,0 +1,66 @@
+module LieDetector
+  class Request
+    def initialize(suite)
+      @suite = suite
+    end
+
+    def method(method)
+      @method = method
+    end
+
+    def path(path)
+      @path = path
+    end
+
+    def data(data)
+      @data = data
+    end
+
+    def query(query)
+      @query = query
+    end
+
+    def headers(headers)
+      @headers = headers
+    end
+
+    def await(trafaret)
+      @trafaret = T.construct(trafaret)
+    end
+
+    def description(description)
+      @description = description
+    end
+
+    def describe
+      "#{@description}\nExecute #{@method.to_s.upcase} #{@path}\n"
+    end
+
+    def status(status)
+      @status = status
+    end
+
+    def store(name)
+      @store_key = name
+    end
+
+    def call
+      res = @suite.session.send(
+        @method,
+        @suite.build_uri(@path, query: @query),
+        {
+          data: @data,
+          header: @suite.headers_defaults.merge(@headers || {})
+        }
+      )
+      unless res.status == @status
+        raise "Bad status(#{@status} != #{res.status}): #{res.inspect}"
+      end
+      res = @trafaret.call(Oj.load(res.content))
+      if res.is_a? Trafaret::Error
+        raise "Unmatched data #{res.dump}"
+      end
+      @suite.store_key(@store_key, res) if @store_key
+    end
+  end
+end

data/lib/liedetector/suite.rb

@@ -0,0 +1,78 @@
+module LieDetector
+  class Suite
+    HEADERS_DEFAULTS = {'Accept' => 'application/json'}
+    HTTP_DEFAULTS = {host: '127.0.0.1', port: 3000}
+
+    def headers_defaults
+      HEADERS_DEFAULTS
+    end
+
+    def initialize(filepath)
+      @filepath = filepath
+    end
+
+    def build_uri(path, query: nil, fragment: nil)
+      query = URI.encode_www_form(query) if query.is_a? Hash
+      URI::HTTP.build(HTTP_DEFAULTS.merge(path: path, query: query, fragment: fragment)).to_s
+    end
+
+    def session
+      @session ||= begin
+        session = HTTPClient.new
+        session.set_cookie_store("cookie.dat")
+        # session.debug_dev = STDOUT
+        session
+      end
+    end
+
+    def push_descriptions(text)
+      @text ||= ''
+      @text += text
+    end
+
+    def register(cls, name)
+      @ordered ||= []
+      @registry ||= {}
+      @ordered << cls
+      @registry[name] = cls if name
+      cls.description(@text || '')
+      @text = ''
+    end
+
+    def store_key(key, data)
+      @store ||= {}
+      @store[key] = data
+    end
+
+    def store_data
+      @store
+    end
+
+    attr_reader :store
+
+    def run
+      markdown = Redcarpet::Markdown.new(LieDetector::MarkdownRunner.new(self), fenced_code_blocks: true)
+      markdown.render(File.new(@filepath).read)
+
+      @ordered.each do |test|
+        puts test.describe
+        test.call
+        puts 'passed'
+        puts
+      end
+    end
+
+    def code_block(code)
+      self.instance_eval(code, @filepath)
+    end
+
+    # Sugar to not define classes in the doc
+    def request(name, method, path, &blk)
+      req = LieDetector::Request.new self
+      req.method method
+      req.path path
+      req.instance_exec &blk
+      register(req, name)
+    end
+  end
+end

data/lib/liedetector/version.rb

@@ -0,0 +1,3 @@
+module LieDetector
+  VERSION = "0.2.1"
+end

data/lib/liedetector.rb

@@ -0,0 +1,9 @@
+require 'redcarpet'
+require 'trafaret'
+require 'httpclient'
+require 'oj'
+T = Trafaret
+
+require 'liedetector/markdown_runner'
+require 'liedetector/suite'
+require 'liedetector/request'

data/liedetector.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liedetector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "liedetector"
+  spec.version       = LieDetector::VERSION
+  spec.authors       = ["Mikhail Krivushin"]
+  spec.email         = ["krivushinme@gmail.com"]
+  spec.summary       = %q{Markdown API description checker}
+  spec.description   = %q{Small lib and script to check API description
+                          in special format against test server}
+  spec.homepage      = "https://github.com/Deepwalker/liedetector.rb"
+  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"
+  spec.add_dependency "trafaret"
+  spec.add_dependency "httpclient"
+  spec.add_dependency "oj"
+  spec.add_dependency "redcarpet"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/liedetector_spec.rb

@@ -0,0 +1,9 @@
+require 'liedetector'
+
+
+describe LieDetector::Suite do
+  it 'should do the task' do
+    suite = LieDetector::Suite.new('sample.md')
+    suite.run
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: liedetector
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Mikhail Krivushin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trafaret
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Small lib and script to check API description
+                            in special format against test server
+email:
+- krivushinme@gmail.com
+executables:
+- liedetector
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/liedetector
+- lib/liedetector.rb
+- lib/liedetector/markdown_runner.rb
+- lib/liedetector/request.rb
+- lib/liedetector/suite.rb
+- lib/liedetector/version.rb
+- liedetector.gemspec
+- spec/liedetector_spec.rb
+homepage: https://github.com/Deepwalker/liedetector.rb
+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: Markdown API description checker
+test_files:
+- spec/liedetector_spec.rb