contracto 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35eed00df100a4c4a2117e8a0d239cb20dcd117
-  data.tar.gz: a55bf9e05603df1c4b03cc354d34096945795d02
+  metadata.gz: 893f39a06bea5e901e247bab7d2de6c37a3a0825
+  data.tar.gz: 1b8741717d48f6fa368529bfdd0c1c5815d67ba1
 SHA512:
-  metadata.gz: 43d467496a10704a35fec13b81d11b1a2ccf4d7e502a371748ae637df018e022191a8af6ef0fd3bcbf056c7730172b4d8ac04484341b4adbfc66512c11919143
-  data.tar.gz: bd325007dca162ebc8f9ae2e4d8c5455c9429ac0bacff26a4fdb003c0fef5a900449874cce5845815b719934d0eeb39466360e3fc3069d295d393ff8c1e33c6e
+  metadata.gz: 18efae1e83e4e38f7746080e0626c18207775f0edd47e5a6b359b66e9266ed57f85b405c38cb977aa22eab1b2b1dfc831f46af2868d76b6a668ab85c7b9385dd
+  data.tar.gz: 975b7ee12c51b0e6d77ea83d1c6510beae86243e872801d3c83b961e3b8d7da17c038234af37bbb72e380dac0644a384c3a4a056b3810e2a1c5afc38f3e1e924

data/README.md

@@ -1,5 +1,3 @@
-# IN DEVELOPMENT
-
 # Contracto
 
 Creates HTTP server based on your contract.
@@ -12,11 +10,11 @@ Creates HTTP server based on your contract.
 
 Start server:
 
-    $ contracto start git@github.com:kv109/contracto_sample-contract.git
+    $ contracto start https://github.com/contracto-lab/contracto-format.git
     
 Test server (default port is __54321__):
 
-    $ curl 0.0.0.0:54321/users; curl 0.0.0.0:54321/users/1; curl 0.0.0.0:54321/users/2
+    $ curl localhost:54321/users; curl localhost:54321/users/1; curl localhost:54321/users/2
     
 Stop server: 
 

data/lib/contracto/command/init.rb

@@ -6,7 +6,7 @@ class Contracto::Command::Init
     initialized = Contracto::SystemActionChain.new(*actions).execute
 
     if initialized
-      puts 'contract initialized, enter \'contracto start\' to start server'
+      puts 'contract initialized, enter "contracto start" to start server'
     else
       puts 'initializing contract failed'
     end

data/lib/contracto/command/start.rb

@@ -3,6 +3,7 @@ class Contracto::Command::Start
   require_relative 'start/local'
 
   def initialize(args)
+    puts 'starting contracto server...'
     if args.first
       @strategy = Contracto::Command::Start::Remote.new(args.first)
     else

data/lib/contracto/command/stop.rb

@@ -3,6 +3,7 @@ class Contracto::Command::Stop
   end
 
   def execute
+    puts 'killing contracto server...'
     Contracto::SystemActionChain.new(*actions).execute
   end
 

data/lib/contracto/config.rb

@@ -4,18 +4,17 @@ class Contracto::Config
   class << self
 
     attr_accessor :repo_url
-    attr_accessor :root_dir
 
     def configure
       yield self if block_given?
     end
 
+    def root_dir=(root_dir)
+      @root_dir = "#{current_dir}/#{root_dir}"
+    end
+
     def root_dir
-      @cached_root_dir ||= if @root_dir
-        "#{current_dir}/#{@root_dir}"
-      else
-        default_root_dir
-      end
+      @root_dir || default_root_dir
     end
 
   end

data/lib/contracto/contract.rb

@@ -1,4 +1,5 @@
 class Contracto::Contract
+  require_relative 'contract/request'
   require_relative 'contract/response'
   require_relative 'stats'
 
@@ -6,8 +7,8 @@ class Contracto::Contract
 
   def initialize(hash)
     @hash = hash
-    @request   = Contracto::Contract::Request.new(@hash.fetch('request'))
-    @responses = Contracto::Contract::Responses.new(@hash.fetch('responses'))
+    @request   = Contracto::Contract::Request.new(@hash.fetch('schema').fetch('request'))
+    @responses = Contracto::Contract::Responses.new(@hash.fetch('examples'))
   end
 
   def http_method
@@ -45,18 +46,4 @@ class Contracto::Contract
       @responses.count
     end
   end
-
-  class Contracto::Contract::Request
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def http_method
-      @hash.fetch('http_method')
-    end
-
-    def url_pattern
-      @hash.fetch('path')
-    end
-  end
-end
+end

data/lib/contracto/contract/request.rb

@@ -0,0 +1,61 @@
+class Contracto::Contract::Request
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def http_method
+    @hash.fetch('method')
+  end
+
+  def url_pattern
+    PathToSinatraPathAdapter.new(@hash.fetch('path')).sinatra_path
+  end
+
+  class PathToSinatraPathAdapter
+    def initialize(path)
+      @path = path
+    end
+
+    def sinatra_path
+      parse_brackets! if path_with_brackets?
+      @path
+    end
+
+    private
+
+    def parse_brackets!
+      if fully_dynamic_route?
+        path_to_regexp!
+      else
+        brackets_to_colons!
+      end
+    end
+
+    def brackets_to_colons!
+      @path.gsub!('{', ':')
+      @path.gsub!('}', '')
+    end
+
+    def path_to_regexp!
+      brackets_to_named_captures!
+      @path = Regexp.new(@path)
+    end
+
+    def brackets_to_named_captures!
+      matches = @path.scan(/(\{([^\/])*\})/).map(&:first)
+      matches.each do |match|
+        @path.gsub! match, "(?<#{match}>\\w*)"
+      end
+      @path.gsub!('{', '')
+      @path.gsub!('}', '')
+    end
+
+    def fully_dynamic_route?
+      !@path.scan(/\}[^\/]/).empty? || !@path.scan(/[^\/]\{/).empty?
+    end
+
+    def path_with_brackets?
+      !!@path.match('{')
+    end
+  end
+end

data/lib/contracto/contract/response.rb

@@ -50,10 +50,7 @@ class Contracto::Contract::Response
   end
 
   def body
-    set_body
-    @body.tap do
-      replace_params_placeholders_with_params_value
-    end
+    File.read(Contracto::Config.root_dir + body_path)
   end
 
   private
@@ -66,18 +63,10 @@ class Contracto::Contract::Response
     end
   end
 
-  def set_body
-    @body = File.read(Contracto::Config.root_dir + body_path)
-  end
-
   def human_header_key_to_http_header_key(key)
     key = key.upcase
     key = key.gsub('-', '_')
     key = 'HTTP_' + key
     key
   end
-
-  def replace_params_placeholders_with_params_value
-    # TODO
-  end
 end

data/lib/contracto/errors.rb

@@ -4,6 +4,9 @@ class Contracto::CouldNotDownloadContractError < StandardError
   end
 end
 
+class Contracto::CouldNotStartServer < StandardError
+end
+
 class Contracto::ServerAlreadyRunningError < StandardError
   def initialize
     super 'Could not start: Contracto server is already running'

data/lib/contracto/server.rb

@@ -0,0 +1,31 @@
+require 'sinatra/base'
+
+class Contracto::Server < Sinatra::Base
+
+  require_relative 'server/controller'
+  require_relative 'stats'
+
+  set :port, Contracto::Constants::PORT
+  set :show_exceptions, false
+
+  get '/contracto' do
+    "*** Contracto server is working! [#{Gem::Specification.find_by_name('contracto').version}] ***"
+  end
+
+  get '/contracto/terminate' do
+    Thread.new { sleep 1; Process.kill 'INT', Process.pid }
+    status 200
+    Contracto::Stats.summary rescue ''
+  end
+
+  not_found do
+    status 404
+    "Could not found example for #{request.url}"
+  end
+
+  error do |ex|
+    status 500
+    ["#{ex.class}: #{ex.message}", ex.backtrace[0, 15].join("\n")].join("\n")
+  end
+end
+

data/lib/contracto/server/contract_routes.rb

@@ -0,0 +1,22 @@
+class Contracto::Server < Sinatra::Base
+
+  jsons_with_contracts = Dir["#{Contracto::Config.root_dir}/**/*.contract.json"].map do |file_with_contract|
+    File.read file_with_contract
+  end
+
+  if jsons_with_contracts.empty?
+    puts "warning: no contracts found in #{Contracto::Config.root_dir}, create some *.contract.json files"
+  end
+
+  Contracto::Parser.new(jsons_with_contracts).contracts.each do |contract|
+    send(contract.http_method, contract.url_pattern) do
+      contract.response_body(params, http_headers)
+    end
+  end
+
+  def http_headers
+    env.select {|k,v| k.start_with? 'HTTP_'}
+  end
+
+end
+

data/lib/contracto/server/controller.rb

@@ -0,0 +1,75 @@
+require 'daemons'
+require 'net/http'
+require 'uri'
+
+class Contracto::Server < Sinatra::Base
+
+  extend Contracto::Constants
+
+  class << self
+
+    def start_contracto_server!
+      if contracto_server_running?
+        puts 'contracto server is already running, enter "contracto stop" to kill it'
+        return
+      elsif !root_dir_exists?
+        puts "current dir does not contain required contracto dir (#{Contracto::Config.root_dir})"
+        return
+      end
+
+      create_routes_from_contract
+      start_daemon!
+      wait_until_server_is_running
+    end
+
+    def stop_contracto_server!
+      uri = URI.parse("http://localhost:#{port}/contracto/terminate")
+      response = Net::HTTP.get_response(uri)
+      if response.is_a?(Net::HTTPOK)
+        puts 'contracto server killed'
+        puts response.body
+      else
+        puts "something went wrong: [#{response.code}] #{response.body}]"
+      end
+    rescue Errno::ECONNREFUSED
+      puts 'contracto server could not be killed (already dead or was never alive)'
+    end
+
+    private
+
+    def root_dir_exists?
+      Dir.exists?(Contracto::Config.root_dir)
+    end
+
+    def contracto_server_running?
+      uri = URI.parse("http://localhost:#{port}/contracto")
+      Net::HTTP.get_response(uri).is_a?(Net::HTTPOK)
+    rescue Errno::ECONNREFUSED
+      false
+    end
+
+    def create_routes_from_contract
+      require_relative 'contract_routes'
+    end
+
+    def start_daemon!
+      Daemons.call(app_name: server_pidfile_name, dir: Contracto::Config.root_dir, dir_mode: :normal) do
+        Contracto::Server.run!
+      end
+    end
+
+    def wait_until_server_is_running
+      10.downto(0).each do |n|
+        sleep 1
+        puts "waiting for contracto server, #{n} tries left..."
+        if contracto_server_running?
+          puts '...contracto server is working'
+          return true
+        end
+      end
+      raise Contracto::CouldNotStartServer
+    end
+  end
+
+end
+

data/lib/contracto/stats.rb

@@ -1,4 +1,7 @@
 class Contracto::Stats
+
+  NA_TEXT = 'N/A'
+
   class << self
     attr_accessor :all_contracts
 
@@ -13,5 +16,35 @@ class Contracto::Stats
     def all_responses
       @all_responses ||= all_contracts.map(&:responses).map(&:count).inject(&:+)
     end
+
+    def contracts_usage
+      return NA_TEXT if all_contracts.size.zero?
+
+      (used_contracts.size/all_contracts.size.to_f).round(2)
+    end
+
+    def responses_usage
+      return NA_TEXT if all_responses.size.zero?
+
+      (used_responses.size/all_responses.size.to_f).round(2)
+    end
+    
+    def contracts_stats_summary
+      "contracts usage: #{used_contracts.size}/#{all_contracts.size} (#{contracts_usage * 100}%)"
+    end
+
+    def responses_stats_summary
+      "examples usage: #{used_responses.size}/#{all_responses.size} (#{responses_usage * 100}%)"
+    end
+
+    def summary
+      length = contracts_stats_summary.length
+      [
+        'stats'.center(length, '-'),
+        contracts_stats_summary,
+        responses_stats_summary,
+        ('-' * length) + ' '
+      ].join("\n")
+    end
   end
-end
+end

data/lib/contracto/system_action.rb

@@ -1,8 +1,11 @@
+require 'fileutils'
+
 class Contracto::SystemAction
-  require 'fileutils'
+  require_relative 'server'
+
+  extend Contracto::Constants
 
   class << self
-    include Contracto::Constants
 
     def create_sample_contract
       if Dir.exists?(Contracto::Config.root_dir)
@@ -17,37 +20,15 @@ class Contracto::SystemAction
     end
 
     def start_server
-      raise Contracto::ServerAlreadyRunningError if server_already_running?
-
-      require_relative 'server/ruby/server'
-      require 'daemons'
-
-      options = {
-        app_name: server_pidfile_name,
-        dir: Contracto::Config.root_dir,
-        dir_mode: :normal
-      }
-
-      Daemons.call(options) do
-        Contracto::Server.run!
-      end
-
-      5.downto(0).each do |n|
-        sleep 1
-        puts "waiting for contracto server, #{n} tries left..."
-        break if test_request(silent: true)
-      end
-    end
-
-    def stop_server
-      puts 'killing server...'
-      system "curl 0.0.0.0:#{port}/contracto_terminate"
-      puts '...server killed'
+      Contracto::Server.start_contracto_server!
     end
 
     def revert_start_server
       stop_server
-    rescue StandardError
+    end
+
+    def stop_server
+      Contracto::Server.stop_contracto_server!
     end
 
     def clone_repo
@@ -66,15 +47,6 @@ class Contracto::SystemAction
       FileUtils.rm_rf Contracto::Config.root_dir
     end
 
-    def server_already_running?
-      test_request(silent: true)
-    end
-
-    def test_request(options = {})
-      args = ''
-      args << '-s -o /dev/null' if options[:silent]
-      system "curl #{args} 0.0.0.0:#{port}/contracto"
-    end
   end
 end
 

data/lib/contracto/version.rb

@@ -1,3 +1,3 @@
 module Contracto
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/spec/fixtures/{get_users_by_id.con.json → get_user_by_id.contract.json}

@@ -1,9 +1,11 @@
 {
-  "request": {
-    "http_method": "get",
-    "path": "/users/:id"
+  "schema": {
+    "request": {
+      "method": "get",
+      "path": "/users/:id"
+    }
   },
-  "responses": [
+  "examples": [
     {
       "request": {
         "params": {

data/spec/fixtures/{get_users.con.json → get_users.contract.json}

@@ -1,9 +1,11 @@
 {
-  "request": {
-    "http_method": "get",
-    "path": "/users"
+  "schema": {
+    "request": {
+      "method": "get",
+      "path": "/users"
+    }
   },
-  "responses": [
+  "examples": [
     {
       "request": {
         "params": {

data/spec/fixtures/{post_users.con.json → post_users.contract.json}

@@ -1,9 +1,11 @@
 {
-  "request": {
-    "http_method": "post",
-    "path": "/users"
+  "schema": {
+    "request": {
+      "method": "post",
+      "path": "/users"
+    }
   },
-  "responses": [
+  "examples": [
     {
       "request": {
         "params": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracto
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Kacper Walanus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -119,11 +119,13 @@ files:
 - lib/contracto/config.rb
 - lib/contracto/constants.rb
 - lib/contracto/contract.rb
+- lib/contracto/contract/request.rb
 - lib/contracto/contract/response.rb
 - lib/contracto/errors.rb
 - lib/contracto/parser.rb
-- lib/contracto/server/ruby/config.ru
-- lib/contracto/server/ruby/server.rb
+- lib/contracto/server.rb
+- lib/contracto/server/contract_routes.rb
+- lib/contracto/server/controller.rb
 - lib/contracto/stats.rb
 - lib/contracto/system_action.rb
 - lib/contracto/system_action_chain.rb
@@ -131,10 +133,9 @@ files:
 - script/send_test_requests.sh
 - script/start_from_remote.sh
 - script/start_locally.sh
-- spec/fixtures/get_users.con.json
-- spec/fixtures/get_users_by_id.con.json
-- spec/fixtures/my_data.con.json
-- spec/fixtures/post_users.con.json
+- spec/fixtures/get_user_by_id.contract.json
+- spec/fixtures/get_users.contract.json
+- spec/fixtures/post_users.contract.json
 - spec/fixtures/users/get_users.json
 - spec/fixtures/users/get_users.xml
 - spec/fixtures/users/get_users_by_id_id_1.json
@@ -168,10 +169,9 @@ signing_key:
 specification_version: 4
 summary: XXX
 test_files:
-- spec/fixtures/get_users.con.json
-- spec/fixtures/get_users_by_id.con.json
-- spec/fixtures/my_data.con.json
-- spec/fixtures/post_users.con.json
+- spec/fixtures/get_user_by_id.contract.json
+- spec/fixtures/get_users.contract.json
+- spec/fixtures/post_users.contract.json
 - spec/fixtures/users/get_users.json
 - spec/fixtures/users/get_users.xml
 - spec/fixtures/users/get_users_by_id_id_1.json

data/lib/contracto/server/ruby/config.ru

@@ -1,5 +0,0 @@
-require File.expand_path('../server', __FILE__)   # hack for replacing #require_relative (see config.ru require_relative issue)
-
-set :run, false
-set :environment, :development
-run Sinatra::Application

data/lib/contracto/server/ruby/server.rb

@@ -1,66 +0,0 @@
-require 'sinatra/base'
-
-class Contracto::Server < Sinatra::Base
-  require_relative '../../stats'
-
-  set :port, Contracto::Constants::PORT
-
-  get '/contracto' do
-    "*** Contracto server is working! [#{Gem::Specification.find_by_name('contracto').version}] ***"
-  end
-
-  get '/contracto_terminate' do
-    Thread.new { sleep 1; Process.kill 'INT', Process.pid }
-    status 200
-    body_on_terminate
-  end
-
-  jsons_with_contracts = Dir["#{Contracto::Config.root_dir}/**/*.con.json"].map do |file_with_contract|
-    File.read file_with_contract
-  end
-
-  Contracto::Parser.new(jsons_with_contracts).contracts.each do |contract|
-    send(contract.http_method, contract.url_pattern) do
-      begin
-        contract.response_body(params, http_headers)
-      rescue StandardError => ex
-        status 500
-        error_response(ex)
-      end
-    end
-  end
-
-  def http_headers
-    env.select {|k,v| k.start_with? 'HTTP_'}
-  end
-
-  def error_response(ex)
-    ["#{ex.class}: #{ex.message}", ex.backtrace[0, 15].join("\n")].join("\n")
-  end
-
-  def body_on_terminate
-    used_contracts_count = Contracto::Stats.used_contracts.size
-    all_contracts_count = Contracto::Stats.all_contracts.size
-    used_responses_count = Contracto::Stats.used_responses.size
-    all_responses_count = Contracto::Stats.all_responses.size
-
-    contracts_usage = if all_contracts_count.zero?
-                        'N/A'
-                      else
-                        "#{(used_contracts_count / all_contracts_count.to_f).round(2)}%"
-                      end
-
-    responses_usage = if all_responses_count.zero?
-                        'N/A'
-                      else
-                        "#{(used_responses_count / all_responses_count.to_f).round(2)}%"
-                      end
-    
-    [
-      "Used contracts: #{used_contracts_count}/#{all_contracts_count} (#{contracts_usage})",
-      "Used responses: #{used_responses_count}/#{all_responses_count} (#{responses_usage})",
-      ''
-    ].join("\n")
-  end
-end
-

data/spec/fixtures/my_data.con.json

@@ -1,23 +0,0 @@
-{
-  "request": {
-    "http_method": "get",
-    "path": "/my/data",
-    "meta": {
-      "request": {
-        
-      },
-      "response": {
-        "body": {
-          "type": "object",
-          "embedded": [
-            {
-              "name": "id",
-              "type": "string"
-            }
-          ]
-        }
-      }
-    }
-  },
-  "responses": []
-}