house_test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30f86898a56ca3a25fdf51b7aa3f2b5a023792a0
+  data.tar.gz: 8a22d9dea25927a632cebbd40a522c320628b659
+SHA512:
+  metadata.gz: af33c1e1e9b9c003a25d76d0a0876b5f70e1a2df89898225bda1ff7a0aaa4a579a63e2c624604f0e27ccd11794b4728b1607086e6dc79344f4b87d4b69e31023
+  data.tar.gz: 792727d92470a5dad57181edf48c591a2edebc63102453f0744cb83f8fee90eaf267307ccba06a0cfce28f593aaa6fd9b9260a4b7cc2c407ccc672c2e448a675

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+Gemfile.lock
+/logs/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 100

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in house_test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Samuel Garratt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# HouseTest
+
+This has some a simple data model for CRUD of entities via API, UI and gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'house_test'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install house_test
+
+## Usage
+
+It has a server and client. To start the server, simply run `house_test`.
+The client is defined in the `House` class.
+
+To create a new house
+```ruby
+House.new(name: 'house name')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/samuelgarratt/house_test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HouseTest project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuelgarratt/house_test/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'house_test'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/house_test

@@ -0,0 +1,6 @@
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'house_test'
+require 'house_test/house_server'
+
+HouseServer.run!

data/house_test.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'house_test/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'house_test'
+  spec.version       = HouseTest::VERSION
+  spec.authors       = ['Samuel Garratt']
+  spec.email         = ['samuel.garratt@integrationqa.com']
+
+  spec.summary       = 'Test system for demonstrating CRUD in API and UI testing.'
+  spec.description   = 'Test system for demonstrating CRUD in API and UI testing.'
+  spec.homepage      = 'https://gitlab.com/samuel-garratt/house_test'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rest-client'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_dependency 'faker'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'sinatra', '2.0.4'
+  spec.add_dependency 'sinatra-basic-auth'
+  spec.add_dependency 'sinatra-docdsl'
+  spec.add_dependency 'soaspec'
+end

data/lib/house_test/backend/house.rb

@@ -0,0 +1,22 @@
+module Backend
+  # House in memory
+  class House
+    # Attributes of a house
+    attr_accessor :name, :rooms, :bathrooms, :garages, :id
+    # Create a new house
+    def initialize(house_params)
+      params = IndifferentHash.new(house_params)
+
+      self.name = params[:name] || Faker::Name.name
+      self.rooms = (params[:rooms] || Faker::Number.number(1)).to_i
+      self.garages = params[:garages] || 1
+      self.bathrooms = params[:bathrooms] || rooms - 1
+      self.id = SecureRandom.uuid
+    end
+
+    # @string [String] JSON representation of House
+    def description
+      JSON.generate(id: id, name: name, rooms: rooms, bathrooms: bathrooms, garages: garages)
+    end
+  end
+end

data/lib/house_test/house_server.rb

@@ -0,0 +1,36 @@
+require 'house_test/backend/house'
+require 'house_test/server/house_server'
+# Representing House objects in 'backend' (memory)
+module HouseTest
+  # List of houses in memory
+  @houses = []
+
+  class << self
+    attr_accessor :houses
+
+    # Add a new house according to parameters passed
+    # @return [String] Id of house just created
+    def add(house_params = {})
+      house = Backend::House.new(house_params)
+      @houses << house
+      house.id
+    end
+
+    # Get an existing house
+    def get(id)
+      houses.find { |house| house.id == id }
+    end
+
+    # Update house at id's key to value
+    def update(id, key, value)
+      found_house = houses.find { |house| house.id == id }
+      found_house.send("#{key}=", value)
+      id
+    end
+
+    # @return [String] Description of all houses
+    def descriptions
+      houses.map(&:description)
+    end
+  end
+end

data/lib/house_test/indifferent_hash.rb

@@ -0,0 +1,7 @@
+require 'hashie'
+
+# Hash that allows accessing hash with either string or Hash
+class IndifferentHash < Hash
+  include Hashie::Extensions::MergeInitializer
+  include Hashie::Extensions::IndifferentAccess
+end

data/lib/house_test/server/house_server.rb

@@ -0,0 +1,67 @@
+require 'sinatra'
+require 'docdsl'
+require 'json'
+
+# Hosts the House server locally
+class HouseServer < Sinatra::Application
+  register Sinatra::DocDsl
+  set :port, HouseTest::PORT
+
+  page do
+    title 'House Server'
+    header 'Testing environment for Web and API testing'
+    introduction 'This has some a simple data model for CRUD of entities via API, UI and gem'
+  end
+
+  doc_endpoint '/docs'
+
+  documentation 'Retrieve all houses' do
+    response 'Description of all houses'
+  end
+  get '/houses' do
+    HouseTest.descriptions.to_s
+  end
+
+  documentation 'Get particular house description'
+  get '/houses/:id' do |id|
+    house = HouseTest.get(id)
+    if house
+      [200, { 'Content-Type' => 'text/json' }, house.description.to_s]
+    else
+      [404, { 'Content-Type' => 'text/json' }, 'Not Found']
+    end
+  end
+
+  patch '/houses/:id' do |id|
+    begin
+      query = JSON.parse(request.body.string)
+      id = HouseTest.update(id, query.keys.first, query.values.first)
+      JSON.generate(updated: id)
+    rescue StandardError => exception
+      exception.message
+    end
+  end
+
+  documentation 'Create a new house'
+  post '/houses' do
+    begin
+      house_id = if request.body.string.empty?
+                   HouseTest.add
+                 else
+                   HouseTest.add(JSON.parse(request.body.string))
+                 end
+    rescue StandardError => exception
+      [200, { 'Content-Type' => 'text/json' }, exception.message]
+    else
+      [200, { 'Content-Type' => 'text/json' }, house_id]
+    end
+  end
+
+  documentation 'Nothing under /. Go look at /docs' do
+    response 'redirects to the documentation page'
+    status 303
+  end
+  get '/' do
+    redirect '/docs'
+  end
+end

data/lib/house_test/version.rb

@@ -0,0 +1,3 @@
+module HouseTest
+  VERSION = '0.1.0'.freeze
+end

data/lib/house_test.rb

@@ -0,0 +1,46 @@
+require 'faker'
+require 'house_test/version'
+require 'house_test/indifferent_hash'
+require 'soaspec'
+
+# The code loaded when simply requiring the gem will only load code for the client
+# Require 'house_test/house_server' to host server
+
+module HouseTest
+  # Port for server to run at
+  PORT = 14_000
+end
+
+# House object that talks to the backend and retrieves house results
+class HouseHandler < Soaspec::RestHandler
+  base_url "http://localhost:#{HouseTest::PORT}/houses"
+end
+
+# Object to represent a client creating objects against a server
+class House
+  # Handles API calls
+  attr_accessor :handler
+  # Attributes mapping to fields in the backend
+  attr_accessor :id
+
+  # Create a new house
+  # @param [Hash] params Parameters to create new house with
+  #                      name, rooms, bathrooms, garages
+  def initialize(params = {})
+    self.handler = HouseHandler
+    exchange = handler.post(body: params)
+    self.id = exchange.response.body
+  end
+
+  %i[name rooms bathrooms garages].each do |attribute|
+    # Retrieve attribute from backend
+    define_method(attribute) do
+      HouseHandler.get(id)[attribute.to_s]
+    end
+
+    # Set attribute in backend
+    define_method("#{attribute}=") do |value|
+      HouseHandler.patch(suburl: id, body: { attribute => value }).response
+    end
+  end
+end

data/rest_client_scripts.rb

@@ -0,0 +1,8 @@
+# Example of using RestClient to create/retrieve houses
+# Can open with 'restclient' on cmd line
+require 'rest_client'
+
+id = RestClient.post('http://localhost:4567/houses', JSON.generate(name: 'test_house')).body
+puts id
+
+RestClient.get('localhost:4567/houses').body

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: house_test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Garratt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rack-test
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: faker
+  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: hashie
+  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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: sinatra-basic-auth
+  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: sinatra-docdsl
+  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: soaspec
+  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'
+description: Test system for demonstrating CRUD in API and UI testing.
+email:
+- samuel.garratt@integrationqa.com
+executables:
+- house_test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/house_test
+- house_test.gemspec
+- lib/house_test.rb
+- lib/house_test/backend/house.rb
+- lib/house_test/house_server.rb
+- lib/house_test/indifferent_hash.rb
+- lib/house_test/server/house_server.rb
+- lib/house_test/version.rb
+- rest_client_scripts.rb
+homepage: https://gitlab.com/samuel-garratt/house_test
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Test system for demonstrating CRUD in API and UI testing.
+test_files: []