poisol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fcbeb995a43c675cf2210d7a48f603401bb2be8
+  data.tar.gz: b81a8125b1ff49b2aba7adbabe655df9ca45a078
+SHA512:
+  metadata.gz: 24f67fabbfcc8a8d97e93c64f3f7656c823701c61d1c4eaaa8121733664afbf6cac12e90539788c04b6a980386a4b9ee7614bce9bb16d1f2769508be43f2cd3a
+  data.tar.gz: be0d4cfaf78a73a481407627500b83c47d1cffa0ec4fb1351cbd1bf7c47edebf35b6c9e3a48bdcafd85b346f92616145196358d47626a9ba87342b971396d110

data/README.md

@@ -0,0 +1,58 @@
+
+[![Build Status](https://travis-ci.org/paramadeep/poisol.svg?branch=master)](https://travis-ci.org/paramadeep/poisol) [![Dependency Status](https://gemnasium.com/paramadeep/poisol.svg)](https://gemnasium.com/paramadeep/poisol) [![Code Climate](https://codeclimate.com/github/paramadeep/poisol/badges/gpa.svg)](https://codeclimate.com/github/paramadeep/poisol)  [![Coverage Status](https://coveralls.io/repos/paramadeep/poisol/badge.png)](https://coveralls.io/r/paramadeep/poisol)
+
+#Poisol
+
+For tests suite that uses stubs for http calls, Poisol generates builder objects that could be used to setup http stubs, similar to data builders used to set up test data in database. 
+
+Hence, avoiding clumsy manual json manipulations and duplications, and keeping test stub data setup as part of test's code.
+
+###Example
+
+Stubbing a http service that provides user identification, gets as simple as 
+
+```ruby
+  User.new.byName('Joe').hasRole('buyer').build  
+  # => webmock that would return role as 'buyer' for http call user 'Joe'
+  
+  User.new.byName('Mani').hasRole('Manager').build 
+  # => webmock that would return role as 'Manager' for http call user 'Mani'
+  
+  User.new.build 
+  # => webmock that would return role as 'Singer' for http call user 'Raji'
+```
+given a minimal configuration
+
+```yaml
+#user.yml
+url: http://authentication.service:80/user
+query: 
+  name: "Raji"
+response_body:
+  '{
+      role: "singer"
+  }'
+```
+Poisol, dynamically generates class called 'User', with methods 'byName' and 'hasRole', which can be used to build as many User's as we need for the tests.
+
+The following can be dynamically configured
+- Request 
+  - url*
+  - type
+  - query params
+  - request body
+- Response 
+  - code*
+  - header*
+  - response body
+
+##ToDo
+* Nested json
+* Array json (column & row)
+* Nested array json
+* URL config 
+* Response code and header config
+* Parent URL
+* Documentation for 'getting started' and details
+* Test coverage
+* Throw error when configured and input field values are different

data/lib/poisol/config_map.rb

@@ -0,0 +1,12 @@
+class ConfigMap
+  @@config_file_map = {}
+
+  def self.add map
+    @@config_file_map.update map
+  end
+
+  def self.file class_name
+    @@config_file_map[class_name]
+  end
+
+end

data/lib/poisol/domain.rb

@@ -0,0 +1,12 @@
+class Domain
+  def self.load domain_config
+    base_hash = Parse.yaml_file domain_config
+    domain  = base_hash["domain"]
+    port = base_hash["port"]
+    @@base_url = "#{domain.chomp('\\')}#{ port.present? ? ":#{port}" : "" }"
+  end
+
+  def self.base_url
+    @@base_url
+  end
+end

data/lib/poisol/stub_config.rb

@@ -0,0 +1,78 @@
+class StubConfig
+  attr_reader :response,:request
+
+  def with_file file_name
+    @config_file = file_name
+    @config = Parse.yaml_file file_name
+    self
+  end
+
+  def is_inline
+    @is_inline = true
+    self
+  end
+
+  def is_exploded
+    @is_inline = false
+    self
+  end
+
+  def build
+    build_request
+    build_response
+    self
+  end
+
+  private
+  def build_request
+    @request = Request.new
+    @request.url = @config["request"]["url"]
+    @request.type = @config["request"]["type"].intern
+    @request.query = @config["request"]["query"]
+    @request.body = @is_inline?  get_inline_request_body : get_exploaded_request_body
+  end
+
+  def build_response
+    @response = Response.new
+    response.body = @is_inline? get_inline_response_body  : get_exploaded_response_body
+    handle_resonse_array_type
+  end
+
+  def handle_resonse_array_type
+    return if @config["response"].nil?
+    array_type = @config["response"]["array_type"]
+    @response.array_type = array_type.nil? ? "" : array_type
+  end
+
+
+  def get_inline_response_body
+    body = @config["response"]["body"]
+    return (body.nil?) ? "": (Parse.json_to_hash body)
+  end
+
+  def get_inline_request_body
+    body = @config["request"]["body"]
+    return (body.nil?) ? "": (Parse.json_to_hash body)
+  end
+
+  def get_exploaded_request_body
+    request_file = "#{File.dirname @config_file}/request.json"
+    return (File.exists? request_file) ? Parse.json_file_to_hash(request_file) : ""
+  end
+
+  def get_exploaded_response_body
+    response_file = "#{File.dirname @config_file}/response.json"
+    return (File.exists? response_file)? Parse.json_file_to_hash(response_file) : ""
+  end
+
+end
+
+
+class Request
+  attr_accessor :url,:type,:query,:body
+end
+
+class Response 
+  attr_accessor :body,:array_type,:is_column_array,:is_row_array
+end
+

data/lib/poisol/stub_factory.rb

@@ -0,0 +1,36 @@
+class StubFactory
+  def build folder
+    folder.chomp! '/'
+    domain_config = Dir["#{folder}/domain.yml"].first
+    explolded_configs =  Dir["#{folder}/**/config.yml"]
+    inline_configs = Dir["#{folder}/**/*.yml"] - ( (explolded_configs.nil?) ?  [] : explolded_configs) - [domain_config]
+    Domain.load domain_config
+    generate_exploded_config explolded_configs unless explolded_configs.nil?
+    generate_inline_config inline_configs unless inline_configs.nil?
+  end
+
+  private
+
+
+  def generate_exploded_config explolded_configs
+    explolded_configs.each do |config_file|
+      dynamic_name = FileUtil.titilze_parent_dir config_file
+      config = StubConfig.new.is_exploded.with_file(config_file).build
+      create_class dynamic_name,config
+    end
+  end
+
+  def generate_inline_config inline_configs
+    inline_configs.each do |config_file|
+      dynamic_name = FileUtil.titilze_file_name config_file
+      config = StubConfig.new.is_inline.with_file(config_file).build
+      create_class dynamic_name,config
+    end
+  end
+
+  def create_class class_name,config
+    ConfigMap.add class_name => config
+    Object.const_set class_name,Class.new {include ClassTemplate}
+  end
+
+end

data/lib/poisol/template/class_template.rb

@@ -0,0 +1,36 @@
+module ClassTemplate
+
+  def initialize
+    @config = ConfigMap.file self.class.name
+    prepare_request
+    prepare_response
+  end
+
+  def prepare_request
+    prepare_request_url
+    prepare_request_query
+    prepare_request_body
+  end
+
+  def prepare_request_url
+    @url = @config.request.url
+    @type = @config.request.type
+  end
+
+  def prepare_request_query
+    @query = (@config.request.query.nil?) ? "" : generate_query_methods
+  end
+
+  def prepare_request_body
+    @request_body = @config.request.body == "" ? "" : generate_request_methods
+  end
+
+  def build
+    stub = stub_request(@type, "http://#{Domain.base_url}/#{@url}")
+    stub.with(:query => @query) unless @query.eql? ""
+    stub.with(:body => @request_body) unless @request_body.eql? ""
+    @response_body = Parse.hash_array_to_column_hash(@response_body) if @config.response.array_type == "column_array"
+    stub.to_return(:status => 200, :body => @response_body, :headers => {})
+  end
+
+end

data/lib/poisol/template/query_handler.rb

@@ -0,0 +1,11 @@
+module ClassTemplate
+    def generate_query_methods
+      @query = @config.request.query 
+      @query.each do |field|
+        define_singleton_method("by#{field[0].capitalize}") do |*value|
+          @query[field[0]] = value[0]
+          self
+        end
+      end
+    end
+end

data/lib/poisol/template/request_handler.rb

@@ -0,0 +1,12 @@
+module ClassTemplate
+    def generate_request_methods 
+      @request_body = @config.request.body 
+      return if @request_body.nil?
+      @request_body.each do |field|
+        define_singleton_method("by_#{field[0].underscore}") do |*value|
+          @request_body[field[0]] = value[0]
+          self
+        end
+      end
+    end
+end

data/lib/poisol/template/response_handler.rb

@@ -0,0 +1,49 @@
+module ClassTemplate
+
+  def prepare_response
+    return if @config.response.body.blank?
+    @config.response.array_type.blank? ? generate_methods_to_alter_response_object : generate_methods_to_alter_response_array
+  end
+
+  def generate_methods_to_alter_response_array
+    @response_body_object = @config.response.body
+    @response_body = []
+    generate_method_to_append_response_array
+    generate_method_to_alter_response_array_object
+  end
+
+  def generate_method_to_alter_response_array_object
+    @response_body_object.each do |field|
+      field_name = field[0]
+      actual_field_value = field[1]
+      define_singleton_method("with_#{field_name.underscore}") do |*input_value|
+        input_value = input_value[0]
+        @response_body.last[field_name] = actual_field_value.class.to_s == "Hash" ? @response_body.last[field_name].deep_merge(input_value) : input_value
+        self
+      end
+    end
+  end
+
+  def generate_method_to_append_response_array
+    object_name = self.class.to_s.classify.underscore
+    method_name = "has_#{object_name}"
+    define_singleton_method(method_name) do
+      @response_body << @response_body_object.deep_dup
+      self
+    end
+  end
+
+  def generate_methods_to_alter_response_object
+    @response_body = @config.response.body
+    @response_body.each do |field|
+      field_name = field[0]
+      actual_field_value = field[1]
+      define_singleton_method("has_#{field_name.underscore}") do |*input_value|
+        input_value = input_value[0]
+        @response_body[field_name] = actual_field_value.class.to_s == "Hash" ? @response_body[field_name].deep_merge(input_value) : input_value
+        self
+      end
+    end
+  end
+
+end

data/lib/poisol/utils/file_util.rb

@@ -0,0 +1,18 @@
+class FileUtil
+
+  def self.titilze_parent_dir file_name
+    titilize File.basename(File.dirname file_name)
+  end
+
+  def self.titilze_file_name file_name
+    titilize ((File.basename file_name).chomp ".yml")
+  end
+
+  private 
+
+  def self.titilize input
+    (input).capitalize.split('_').reduce{|c,a| c+a.capitalize}
+  end
+
+end
+

data/lib/poisol/utils/parse.rb

@@ -0,0 +1,25 @@
+class Parse
+
+  def self.json_file_to_hash file_name
+    JSON.parse File.read(file_name)
+  end 
+
+  def self.yaml_file file_name
+    YAML.load_file(file_name)
+  end
+
+  def self.json_to_hash json
+    JSON.parse json
+  end
+
+  def self.hash_array_to_column_hash hash_array
+    column_hash = Hash.new
+    hash_array[0].each_key { |key| column_hash.merge!(key=>[])}
+    hash_array.each do |hash|
+      column_hash.each_key {|key| column_hash[key].append hash[key]}
+    end
+    return column_hash
+  end
+
+end
+

data/lib/poisol.rb

@@ -0,0 +1,2 @@
+require 'active_support/all'
+Dir["#{File.dirname(__FILE__)}/poisol/**/*.rb"].each { |f| require(f) }

data/spec/class_template/array_spec.rb

@@ -0,0 +1,15 @@
+describe ClassTemplate, "#array" do
+
+  it "column array" do
+    Columns.new.has_column.has_column.with_title("abc").with_category("12").build
+    response = RestClient.get "http://localhost:80/column"
+    expect(response.body).to eq({"title"=>["independance", "abc"], "category"=>["10","12"]})
+  end
+
+  it "row array" do
+    Rows.new.has_row.has_row.with_title("abc").with_category("age_group" => "12").build
+    response = RestClient.get "http://localhost:80/row"
+    expect(response.body).to eq([{"title"=>"independance", "category"=>{"age_group"=>"10"}}, {"title"=>"abc", "category"=>{"age_group"=>"12"}}])
+  end
+
+end

data/spec/class_template/get_spec.rb

@@ -0,0 +1,16 @@
+describe ClassTemplate, "#get_books" do
+
+  it "default request and response" do
+    Book.new.build()
+    response = RestClient.get "http://localhost:80/book",{:params => {:author=>'bharathi'}}
+    expect(response.body).to eq("title"=>"independance", "category"=>{"age_group"=>"10", "genre"=>"action", "publisher"=>{"name"=>"summa", "place"=>"erode"}})
+  end
+
+  it "dynamic response" do
+    Book.new.has_category({"age_group"=>"11", "publisher"=>{"name"=>"oxford"}}).build()
+    response = RestClient.get "http://localhost:80/book",{:params => {:author=>'bharathi'}}
+    expect(response.body).to eq("title"=>"independance", "category"=>{"age_group"=>"11", "genre"=>"action", "publisher"=>{"name"=>"oxford", "place"=>"erode"}})
+  end
+
+end
+

data/spec/class_template/post_spec.rb

@@ -0,0 +1,18 @@
+describe ClassTemplate, "#post_user" do
+
+  it "default request and response" do
+    User.new.build()
+    response = RestClient.post "http://localhost:80/users","name"=>"deepak"
+    expect(response.body).to eq("job"=>'sleeping_bag')
+  end
+
+  it "dynamic request and response" do
+    name = "ummy"
+    job = "vetti"
+    User.new.by_name(name).has_job(job).build()
+    response = RestClient.post "http://localhost:80/users","name"=>name
+    expect(response.body).to eq("job"=>job)
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "rspec/expectations"
+require 'rest_client'
+require 'webmock'
+include WebMock::API
+
+require_relative '../lib/poisol'
+require 'pry'
+
+require 'simplecov'
+SimpleCov.minimum_coverage 40
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter
+]
+SimpleCov.start
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    WebMock.reset!
+  end
+
+  config.before(:suite) do
+    WebMock.disable_net_connect!(:allow_localhost => true)
+    factory = StubFactory.new.build("data")
+  end
+
+end
+

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: poisol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Deepak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+description: Data builders for http stubs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/poisol.rb
+- lib/poisol/config_map.rb
+- lib/poisol/domain.rb
+- lib/poisol/stub_config.rb
+- lib/poisol/stub_factory.rb
+- lib/poisol/template/class_template.rb
+- lib/poisol/template/query_handler.rb
+- lib/poisol/template/request_handler.rb
+- lib/poisol/template/response_handler.rb
+- lib/poisol/utils/file_util.rb
+- lib/poisol/utils/parse.rb
+- spec/class_template/array_spec.rb
+- spec/class_template/get_spec.rb
+- spec/class_template/post_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paramadeep/poisol
+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: Data builders for http stubs
+test_files:
+- spec/spec_helper.rb
+- spec/class_template/post_spec.rb
+- spec/class_template/get_spec.rb
+- spec/class_template/array_spec.rb