liedetector 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa03058163399affa0461be6673a9d3e5a12c890
-  data.tar.gz: 1c53a79fe362a04d08772d26bc805877c9b2e098
+  metadata.gz: d84111e812b82ef363c85d668e92616882f427de
+  data.tar.gz: 85b6313e88873a8d3d6c612b3ee196129298337a
 SHA512:
-  metadata.gz: 20a421fc36dbd658fc3d6dbed033d94e32c3a8e5fd8f1ae71bab8e42304636698037baec78522f5c8dcfc6bcb78bd548eb1b26443f5f9b8953361cc8466018af
-  data.tar.gz: 5d19b4011700ddd9b7482a5b1164929d64846d2c666e8cef031f92203039cd5eadd76da67b88f1de953d83f5d718e486a3b1ae95f9657bca6d3d757bc2e9f17a
+  metadata.gz: befffc92abd9982fd475aadfdfafa9820d165edcb1685c802b437a01670a8e1be840a168e1b1cecb26e103186d5f7eeb03eba6fa5838026f2ef19889996a70e9
+  data.tar.gz: c0a41b51b26680ec9fad5a368e3b45728fa2a5dc6d4d065eff3950faf2cdd40d29fe6031b808bafb3a4a893185f8472928cdbc809634cf92f21ca89efad01987

data/README.md

@@ -0,0 +1,46 @@
+LieDetector
+===========
+
+I created this gem to keep API description and actual API in sync. You write markdown document
+with data structures and request descriptions, and then you can check it against real server
+to check that description is really describe this server API.
+
+All requests executed one by one, and if any of them fail we stop checking.
+
+So, take a look at some example - current document describe a bit of GitHub API.
+
+GitHub API Check
+----------------
+
+As you know github has public API. API you can call without authentification.
+Set API host:
+
+    self.http_defaults = {host: 'api.github.com', scheme: 'https', port: 443}
+
+With Trafaret library we can define data types to check API results:
+
+    Repo = T.construct({
+      id: :integer,
+      name: :string,
+      full_name: :string,
+      # ... hundred of other fields, tired to define them
+      owner: {url: :uri}
+    })
+
+So now we can get info about liedetector repo, store it, and then use it for next queries:
+
+    request :repo_info, :get, '/repos/Deepwalker/liedetector' do
+      status 200
+      await Repo
+      store :repo # we store API call result for later
+    end
+
+Now we have repo info, and URI for it owner. Lets check this URI:
+
+    request :repo_owner, :get, proc { URI.parse(store[:repo][:owner][:url]).path } do
+      status 200
+      await :any
+    end
+
+You can put proc {} in place of method, path, status, data, query and headers request args. As you see
+request get name, method and path, and then with block you fill other parameters.

data/lib/liedetector/suite.rb

@@ -1,21 +1,23 @@
 module LieDetector
   class Suite
-    HEADERS_DEFAULTS = {'Accept' => 'application/json'}
-    HTTP_DEFAULTS = {host: '127.0.0.1', port: 3000}
-
-    attr_accessor :http_defaults
-
-    def headers_defaults
-      HEADERS_DEFAULTS
-    end
+    attr_accessor :http_defaults, :headers_defaults
 
     def initialize(filepath)
       @filepath = filepath
+      self.headers_defaults = {'Accept' => 'application/json'}
+      self.http_defaults = {host: '127.0.0.1', port: 3000}
     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
+      scheme = http_defaults[:scheme] || 'http'
+      if scheme == 'http'
+        URI::HTTP
+      elsif scheme == 'https'
+        URI::HTTPS
+      else
+        raise 'Bad configuration'
+      end.build(http_defaults.merge(path: path, query: query, fragment: fragment)).to_s
     end
 
     def session

data/lib/liedetector/version.rb

@@ -1,3 +1,3 @@
 module LieDetector
-  VERSION = "0.2.2"
+  VERSION = "0.2.5"
 end

data/spec/liedetector_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liedetector
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Mikhail Krivushin
@@ -134,6 +134,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - bin/liedetector
 - lib/liedetector.rb