contracto 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6005fbde75b11e623c24520cb900b7b67d8c4d22
-  data.tar.gz: c6361eb19b087c19362defca14119539279254fe
+  metadata.gz: 58f8e5bbd43d3c7f0cc80462dd1c199a6c734b57
+  data.tar.gz: 2d9e6e2a914a81128f0e6aea61cf1dec04451328
 SHA512:
-  metadata.gz: f8c4f59416fd12ca16374540b24107850b0fa0ffb6f3d78112bc989bc67ecb19ac96b3b392f0b11d6f645c7f6b724d750ede6a36ceef6efde69dcd7f156c62f9
-  data.tar.gz: e38db2813dec339fea3215547651fd5e958d7b713e7ad9f1d1e2ad27d7a2e822212741d43f587721d0fcfac01bb4c2f944f2dfcda002aaaea5633207af12f51e
+  metadata.gz: 3d31d65158ca0e151e0e30eaa207cff7a87ef4595030770aad0e55f8f4ebc83ef4a48a286c0105ff21401a6c5460125682c3fc48b447042ef5513378551bb6c6
+  data.tar.gz: 0890abb491534d3f6e3c14329f2061fccf06f88a85b7d294714570f72bf0f54e4da5ec5bed6de2d435e4274047d566f390efc6d13fb5b1fc206dab30d3f356e8

data/contracto.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'sinatra', '~> 1.4'
 
+  spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/contracto.rb

@@ -1,15 +1,11 @@
 require_relative 'contracto/version' # TODO: replace all #require with #require_relative
 
 module Contracto
-  GEM_DIR               = Gem::Specification.find_by_name('contracto').gem_dir
-  CONTRACTO_DIR         = 'contracto'
-  CONTRACTO_TMP_DIR     = '.tmp.contracto'
-  RUBY_SERVER_DIR       = "#{GEM_DIR}/lib/contracto/server/ruby"
-  CONTRACT_FILENAME     = 'contract.cdc.rb'
-  CONTRACT_PID_FILEPATH = "#{CONTRACTO_DIR}/server.pid"
-
   require_relative 'contracto/errors'
-  require_relative 'contracto/installer'
-  require_relative 'contracto/runner'
-  require_relative 'contracto/terminator'
+  require_relative 'contracto/constants'
+  require_relative 'contracto/config'
+  require_relative 'contracto/contract'
+  require_relative 'contracto/parser'
+  require_relative 'contracto/system_action_chain'
+  require_relative 'contracto/command'
 end

data/lib/contracto/command.rb

@@ -1,14 +1,17 @@
 class Contracto::Command
+  require_relative 'command/init'
+  require_relative 'command/start'
+  require_relative 'command/stop'
   class << self
 
     def run(command, args)
       case command
         when 'init'
-          Contracto::Installer.new(args).execute
+          Contracto::Command::Init.new(args).execute
         when 'start'
-          Contracto::Runner.new(args).execute
+          Contracto::Command::Start.new(args).execute
         when 'stop'
-          Contracto::Terminator.new(args).execute
+          Contracto::Command::Stop.new(args).execute
       end
     end
   end

data/lib/contracto/command/init.rb

@@ -0,0 +1,24 @@
+class Contracto::Command::Init
+  def initialize(args)
+  end
+
+  def execute
+    initialized = Contracto::SystemActionChain.new(*actions).execute
+
+    if initialized
+      puts 'contract initialized, enter \'contracto start\' to start server'
+    else
+      puts 'initializing contract failed'
+    end
+  end
+
+  private
+
+  def actions
+    [
+      :remove_contracto_dir,
+      :copy_server_files,
+      :create_sample_contract
+    ]
+  end
+end

data/lib/contracto/command/start.rb

@@ -0,0 +1,16 @@
+class Contracto::Command::Start
+  require_relative 'start/remote'
+  require_relative 'start/local'
+
+  def initialize(args)
+    if args.first
+      @strategy = Contracto::Command::Start::Remote.new(args.first)
+    else
+      @strategy = Contracto::Command::Start::Local.new
+    end
+  end
+
+  def execute
+    @strategy.execute
+  end
+end

data/lib/contracto/command/start/local.rb

@@ -0,0 +1,11 @@
+class Contracto::Command::Start::Local
+  def execute
+    Contracto::SystemActionChain.new(*actions).execute
+  end
+
+  private
+
+  def actions
+    [:start_server]
+  end
+end

data/lib/contracto/command/start/remote.rb

@@ -0,0 +1,22 @@
+class Contracto::Command::Start::Remote
+  def initialize(repo_url)
+    Contracto::Config.repo_url = repo_url
+  end
+
+  def execute
+    puts "downloading contract from #{Contracto::Config.repo_url}"
+    Contracto::SystemActionChain.new(*actions).execute
+  end
+
+  private
+
+  def actions
+    [
+      :clone_repo_to_tmp_contracto_dir,
+      :move_repo_files_to_root_dir,
+      :remove_tmp_contracto_dir,
+      :copy_server_files,
+      :start_server
+    ]
+  end
+end

data/lib/contracto/command/stop.rb

@@ -0,0 +1,14 @@
+class Contracto::Command::Stop
+  def initialize(args)
+  end
+
+  def execute
+    Contracto::SystemActionChain.new(*actions).execute
+  end
+
+  private
+
+  def actions
+    [:stop_server]
+  end
+end

data/lib/contracto/config.rb

@@ -0,0 +1,11 @@
+class Contracto::Config
+  class << self
+    def repo_url=(repo_url)
+      @repo_url = repo_url
+    end
+
+    def repo_url
+      @repo_url
+    end
+  end
+end

data/lib/contracto/constants.rb

@@ -0,0 +1,37 @@
+module Contracto::Constants
+  GEM_DIR               = Gem::Specification.find_by_name('contracto').gem_dir
+  CONTRACTO_DIR         = '.contracto'
+  CONTRACTO_TMP_DIR     = '.tmp.contracto'
+  RUBY_SERVER_DIR       = "#{GEM_DIR}/lib/contracto/server/ruby"
+  CONTRACT_FILENAME     = 'contract.con.json'
+  CONTRACT_PID_FILEPATH = "#{CONTRACTO_DIR}/server.pid"
+  PORT                  = 54321
+
+  def gem_dir
+    GEM_DIR
+  end
+
+  def contracto_dir
+    CONTRACTO_DIR
+  end
+
+  def contracto_tmp_dir
+    CONTRACTO_TMP_DIR
+  end
+
+  def ruby_server_dir
+    RUBY_SERVER_DIR
+  end
+
+  def contract_filename
+    CONTRACT_FILENAME
+  end
+
+  def contract_pid_filepath
+    CONTRACT_PID_FILEPATH
+  end
+
+  def port
+    PORT
+  end
+end

data/lib/contracto/contract.rb

@@ -0,0 +1,32 @@
+class Contracto::Contract
+  def initialize(hash)
+    @hash = hash
+    @request = Contracto::Contract::Request.new(@hash.fetch('request'))
+  end
+
+  def http_method
+    @request.http_method
+  end
+
+  def url_pattern
+    @request.url_pattern
+  end
+
+  def response_body(params)
+    params.to_s
+  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

data/lib/contracto/parser.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+class Contracto::Parser
+  def initialize(strings_with_json)
+    @json_collection = strings_with_json.map { |string| JSON.parse(string) }
+  end
+
+  def contracts
+    @json_collection.map do |json|
+      Array(json).map do |json|
+        Contracto::Contract.new(json)
+      end
+    end.flatten
+  end
+end

data/lib/contracto/server/ruby/contract.con.json

@@ -0,0 +1,46 @@
+[
+  {
+    "request": {
+      "http_method": "get",
+      "path": "/users"
+    },
+    "examples": [
+      {
+        "request": {
+          "headers": {
+            "Content-Type": "application/json"
+          },
+          "body": {
+            "firstName": "Max",
+            "lastName": "Lincoln"
+          }
+        },
+        "response": {
+          "body": {}
+        }
+      }
+    ]
+  },
+  {
+    "request": {
+      "http_method": "get",
+      "path": "/users/:id"
+    },
+    "examples": [
+      {
+        "request": {
+          "headers": {
+            "Content-Type": "application/json"
+          },
+          "body": {
+            "firstName": "Max",
+            "lastName": "Lincoln"
+          }
+        },
+        "response": {
+          "body": {}
+        }
+      }
+    ]
+  }
+]

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

@@ -1,8 +1,17 @@
 require 'sinatra'
+require 'contracto'
 
 get '/contracto' do
   "*** Contracto server is working! [#{Gem::Specification.find_by_name('contracto').version}] ***"
 end
 
-require './contract.cdc.rb'
+json_string = File.read Contracto::Constants::CONTRACT_FILENAME
+json_strings = [json_string]
+
+Contracto::Parser.new(json_strings).contracts.each do |contract|
+  send(contract.http_method, contract.url_pattern) do
+    contract.response_body(params)
+  end
+end
+
 

data/lib/contracto/system_action.rb

@@ -0,0 +1,125 @@
+class Contracto::SystemAction
+  class << self
+    include Contracto::Constants
+
+    def remove_contracto_dir
+      FileUtils.rm_rf contracto_dir
+    end
+
+    def remove_tmp_contracto_dir
+      FileUtils.rm_rf contracto_tmp_dir
+    end
+
+    def copy_server_files
+      FileUtils.cp_r ruby_server_dir, contracto_tmp_dir
+      FileUtils.mv contracto_tmp_dir, contracto_dir
+    end
+
+    def revert_copy_server_files
+      remove_contracto_dir
+      remove_tmp_contracto_dir
+    end
+
+    def create_sample_contract
+      if contract_already_exists?
+        puts 'contract already exists, creating sample contract skipped'
+        remove_sample_contract
+      else
+        FileUtils.mv sample_contract_path, FileUtils.pwd
+        puts "created: #{contract_filename}"
+      end
+    end
+
+    def start_server
+      raise Contracto::ServerAlreadyRunningError if server_already_running?
+
+      system "rackup #{contracto_dir}/config.ru -p #{port} -D -P #{contract_pid_filepath}"
+      # TODO: loop below should terminate after n tries
+      system "while ! echo exit | nc localhost #{port} > /dev/null && echo \"waiting for contracto server...\"; do sleep 1; done"
+      test_request
+    end
+
+    def stop_server
+      puts 'killing server...'
+      Process.kill(15, File.read(contract_pid_filepath).to_i)
+      puts '...server killed'
+    rescue Errno::ENOENT
+      puts 'could not kill server (pidfile not found)'
+    end
+
+    def revert_start_server
+      stop_server
+    rescue StandardError
+    end
+
+    def clone_repo_to_tmp_contracto_dir
+      success = system "git clone -q  --depth 1 --single-branch --branch master #{Contracto::Config.repo_url} #{contracto_tmp_dir}"
+      raise(Contracto::CouldNotDownloadContractError.new(Contracto::Config.repo_url)) unless success
+    end
+
+    def revert_clone_repo_to_tmp_contracto_dir
+      remove_tmp_contracto_dir
+    end
+
+    def move_repo_files_to_root_dir
+      system "mv #{contracto_tmp_dir}/* #{contracto_tmp_dir}/.[^.]* . 2> /dev/null"  # Could not use FileUtils for some reason
+    end
+    
+    private
+
+    def contract_already_exists?
+      File.exist?(contract_filename)
+    end
+
+    def remove_sample_contract
+      FileUtils.rm sample_contract_path
+    end
+
+    def sample_contract_path
+      "#{contracto_dir}/#{contract_filename}"
+    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
+
+class Contracto::SystemActionChain
+  def initialize(*actions)
+    @actions = actions
+    @finished_actions = []
+  end
+
+  def execute
+    perform_actions and true
+  rescue StandardError => e
+    revert_actions and false
+    raise e
+  end
+
+  private
+
+  def perform_actions
+    @actions.each do |action|
+      @finished_actions << action
+      Contracto::SystemAction.send(action)
+    end
+  end
+
+  def revert_actions
+    @finished_actions.reverse.each do |action|
+      revert_method_name = "revert_#{action}"
+      if Contracto::SystemAction.respond_to? revert_method_name
+        Contracto::SystemAction.send revert_method_name
+      end
+    end
+  rescue StandardError
+  end
+end

data/lib/contracto/system_action_chain.rb

@@ -0,0 +1,34 @@
+class Contracto::SystemActionChain
+  require_relative 'system_action'
+
+  def initialize(*actions)
+    @actions = actions
+    @finished_actions = []
+  end
+
+  def execute
+    perform_actions and true
+  rescue StandardError => e
+    revert_actions and false
+    raise e
+  end
+
+  private
+
+  def perform_actions
+    @actions.each do |action|
+      @finished_actions << action
+      Contracto::SystemAction.send(action)
+    end
+  end
+
+  def revert_actions
+    @finished_actions.reverse.each do |action|
+      revert_method_name = "revert_#{action}"
+      if Contracto::SystemAction.respond_to? revert_method_name
+        Contracto::SystemAction.send revert_method_name
+      end
+    end
+  rescue StandardError
+  end
+end

data/lib/contracto/version.rb

@@ -1,3 +1,3 @@
 module Contracto
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/script/start_from_remote.sh

@@ -5,3 +5,4 @@ cd tmp
 contracto start https://github.com/kv109/cdc-sample-contract.git
 contracto stop
 cd ..
+rm -rf tmp

data/script/start_locally.sh

@@ -6,3 +6,4 @@ contracto init
 contracto start
 contracto stop
 cd ..
+rm -rf tmp

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require_relative '../lib/contracto'
+
+STRINGS_WITH_JSON = []
+STRINGS_WITH_JSON << <<JSON
+{
+  "request": {
+    "http_method": "get",
+    "path": "/api/users"
+  },
+  "examples": [
+    {
+      "request": {
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "firstName": "Max",
+          "lastName": "Lincoln"
+        }
+      },
+      "response": {
+        "body": { }
+      }
+    }
+  ]
+}
+JSON
+
+STRINGS_WITH_JSON << <<JSON
+{
+  "request": {
+    "http_method": "get",
+    "path": "/api/users/:id"
+  },
+  "examples": [
+    {
+      "request": {
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "firstName": "Max",
+          "lastName": "Lincoln"
+        }
+      },
+      "response": {
+        "body": { }
+      }
+    }
+  ]
+}
+JSON

data/spec/unit/parser_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe Contracto::Parser do
+  context '#contracts' do
+    subject { described_class.new(STRINGS_WITH_JSON).contracts }
+
+    it do
+      expect(subject).to be_a Array
+      expect(subject.first).to be_a Contracto::Contract
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracto
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kacper Walanus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,19 +83,26 @@ files:
 - contracto.gemspec
 - lib/contracto.rb
 - lib/contracto/command.rb
+- lib/contracto/command/init.rb
+- lib/contracto/command/start.rb
+- lib/contracto/command/start/local.rb
+- lib/contracto/command/start/remote.rb
+- lib/contracto/command/stop.rb
+- lib/contracto/config.rb
+- lib/contracto/constants.rb
+- lib/contracto/contract.rb
 - lib/contracto/errors.rb
-- lib/contracto/installer.rb
-- lib/contracto/runner.rb
-- lib/contracto/runner/base.rb
-- lib/contracto/runner/local.rb
-- lib/contracto/runner/remote.rb
+- lib/contracto/parser.rb
 - lib/contracto/server/ruby/config.ru
-- lib/contracto/server/ruby/contract.cdc.rb
+- lib/contracto/server/ruby/contract.con.json
 - lib/contracto/server/ruby/server.rb
-- lib/contracto/terminator.rb
+- lib/contracto/system_action.rb
+- lib/contracto/system_action_chain.rb
 - lib/contracto/version.rb
 - script/start_from_remote.sh
 - script/start_locally.sh
+- spec/spec_helper.rb
+- spec/unit/parser_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -106,4 +127,6 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: XXX
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/parser_spec.rb

data/lib/contracto/installer.rb

@@ -1,52 +0,0 @@
-require 'fileutils'
-
-class Contracto::Installer
-  def initialize(args)
-  end
-
-  def execute
-    remove_old_dir
-    cp_server_files
-    if contract_already_exists?
-      remove_sample_contract_file
-    else
-      create_contract
-    end
-    puts 'contracto initialized'
-    puts "start writing contracts in #{Contracto::CONTRACT_FILENAME}"
-  rescue
-    revert
-  end
-
-  private
-
-  def remove_old_dir
-    FileUtils.rm_rf Contracto::CONTRACTO_DIR
-  end
-
-  def cp_server_files
-    FileUtils.cp_r Contracto::RUBY_SERVER_DIR, Contracto::CONTRACTO_TMP_DIR
-    FileUtils.mv Contracto::CONTRACTO_TMP_DIR, Contracto::CONTRACTO_DIR
-  end
-
-  def create_contract
-    FileUtils.mv sample_contract_path, FileUtils.pwd
-    puts "created: #{installer.CONTRACT_FILENAME}"
-  end
-
-  def contract_already_exists?
-    File.exist? Contracto::CONTRACT_FILENAME
-  end
-
-  def remove_sample_contract_file
-    FileUtils.rm sample_contract_path
-  end
-
-  def sample_contract_path
-    "#{Contracto::CONTRACTO_DIR}/#{Contracto::CONTRACT_FILENAME}"
-  end
-
-  def revert
-    # TODO: implement
-  end
-end

data/lib/contracto/runner.rb

@@ -1,17 +0,0 @@
-class Contracto::Runner
-  require_relative 'runner/base'
-  require_relative 'runner/remote'
-  require_relative 'runner/local'
-
-  def initialize(args)
-    if args.first
-      @strategy = Contracto::Runner::Remote.new(args)
-    else
-      @strategy = Contracto::Runner::Local.new(args)
-    end
-  end
-
-  def execute
-    @strategy.execute
-  end
-end

data/lib/contracto/runner/base.rb

@@ -1,36 +0,0 @@
-class Contracto::Runner::Base
-  PORT = 54321
-
-  def initialize(args)
-    @args = args
-  end
-
-  def execute
-    raise NotImplementedError
-  end
-
-  private
-
-  def start_server
-    raise Contracto::ServerAlreadyRunningError if server_already_running?
-
-    system "rackup #{Contracto::CONTRACTO_DIR}/config.ru -p #{PORT} -D -P #{Contracto::CONTRACT_PID_FILEPATH}"
-    # TODO: loop below should terminate after n tries
-    system "while ! echo exit | nc localhost #{PORT} > /dev/null && echo \"waiting for contracto server...\"; do sleep 1; done"
-    test_request
-  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
-
-  def server_repo_url
-    @args.first
-  end
-end

data/lib/contracto/runner/local.rb

@@ -1,5 +0,0 @@
-class Contracto::Runner::Local < Contracto::Runner::Base
-  def execute
-    start_server
-  end
-end

data/lib/contracto/runner/remote.rb

@@ -1,29 +0,0 @@
-class Contracto::Runner::Remote < Contracto::Runner::Base
-  require 'fileutils'
-
-  def execute
-    puts 'downloading contract...'
-    clone_repo || raise(Contracto::CouldNotDownloadContractError.new(server_repo_url))
-    mv_repo_files_to_current_dir
-    remove_old_repo_dir
-    start_server
-  end
-
-  private
-
-  def clone_repo
-    system "git clone -q  --depth 1 --single-branch --branch master #{server_repo_url} #{tmp_dir}"
-  end
-
-  def mv_repo_files_to_current_dir
-    system "mv #{tmp_dir}/* #{tmp_dir}/.[^.]* . 2> /dev/null"  # Could not use FileUtils for some reason
-  end
-
-  def remove_old_repo_dir
-    FileUtils.rm_rf tmp_dir
-  end
-
-  def tmp_dir
-    Contracto::CONTRACTO_TMP_DIR
-  end
-end

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

@@ -1,5 +0,0 @@
-# TODO: Should require all *.cdc.rb files
-
-get '/dummy' do
-  'You can start working on your contract'
-end

data/lib/contracto/terminator.rb

@@ -1,10 +0,0 @@
-class Contracto::Terminator
-  def initialize(args)
-  end
-
-  def execute
-    puts 'killing server...'
-    Process.kill(15, File.read(Contracto::CONTRACT_PID_FILEPATH).to_i)
-    puts 'server terminated'
-  end
-end