watir_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00da5b6321bda48b3657842314ed6de70ff47950
+  data.tar.gz: b7286ae2ee5779433b2b7364cecc181053e3b14a
+SHA512:
+  metadata.gz: '08d1724faed27a8122db5bf2b1268897373fecb437480c77fb40fa3497ce8241b6c07f0c2afcdc296551bd8a94ef8911e6ca29638289213ee22e78cd7398ba05'
+  data.tar.gz: c4553e0c0864f6d4bf10b257df294ca6740d82f1cdd26e2d8402e66d1cc710c3c995807e5f29f1cf3c24eb17d010d6d46ff9fc6b53bd0a1b1e61405da8284e4a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

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 watir_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Titus Fortner
+
+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,33 @@
+# WatirApi
+
+Send and receive data via a Web App's API, ideally using WatirModel objects. The goal is to
+compare test data with what is input and displayed via UI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install watir_api
+
+## Usage
+
+This gem is still in beta; if you have suggestions to improve it, please write some code or
+raise an issue on Github
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/titusfortner/watir_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/watir_api.rb

@@ -0,0 +1,94 @@
+require "rest-client"
+require "json"
+
+module WatirApi
+  class Base
+    class << self
+
+      def index(opt = {})
+        new rest_call(:get, route, opt)
+      end
+
+      def show(id:, **opt)
+        new rest_call(:get, "#{route}/#{id}", opt)
+      end
+
+      def create(obj = nil)
+        new rest_call(:post, route, generate_payload(obj), content_type: :json)
+      end
+
+      def destroy(id:, **opt)
+        new rest_call(:delete, "#{route}/#{id}", opt)
+      end
+
+      def update(id:, with:, **opt)
+        new rest_call(:put, "#{route}/#{id}", generate_payload(with), opt)
+      end
+
+      def base_url=(base_url)
+        @@base_url = base_url
+      end
+
+      def base_url
+        @@base_url || ''
+      end
+
+      def route
+        "#{base_url}/#{endpoint}"
+      end
+
+      def endpoint
+        ''
+      end
+
+      def model_object
+        eval "Model::#{self.to_s[/[^:]*$/]}"
+      end
+
+      private
+
+      def rest_call(method, *args)
+        RestClient.send(method, *args)
+      rescue => e
+        e.response
+      end
+
+      def generate_payload(obj)
+        case obj
+        when NilClass
+          model_object.new.to_api
+        when WatirModel
+          obj.to_api
+        when JSON
+          # noop
+        else
+          obj.to_json
+        end
+      end
+    end
+
+    attr_reader :data, :code, :response
+
+    def initialize(response)
+      @response = response
+      @code = response.code
+      @data = JSON.parse(response.body, symbolize_names: true) rescue nil
+      @data = (convert_to_model(@data) || @data) unless @data.nil? || !(defined? model_object.new)
+    end
+
+    def convert_to_model(data)
+      if data.is_a? Hash
+        (model_object.keys & data.keys).empty? ? return : model_object.convert(data)
+      elsif data.is_a? Array
+        data.map do |hash|
+          model = convert_to_model(hash)
+          model.nil? ? return : model
+        end
+      end
+    end
+
+    def model_object
+      self.class.model_object
+    end
+  end
+end

data/watir_api.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "watir_api"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Titus Fortner"]
+  spec.email         = ["titusfortner@gmail.com"]
+
+  spec.summary       = %q{A simple class for interacting with a Web App's API using test data}
+  spec.description   = %q{Send and receive data via a Web App's API, ideally using WatirModel objects. The goal is to
+compare test data with what is input and displayed via UI.}
+  spec.homepage      = "https://github.com/titusfortner/watir_api"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "faker"
+  spec.add_runtime_dependency "watir_model", "~> 0.4.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "require_all"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: watir_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: 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: watir_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !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: 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: 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: require_all
+  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'
+description: |-
+  Send and receive data via a Web App's API, ideally using WatirModel objects. The goal is to
+  compare test data with what is input and displayed via UI.
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/watir_api.rb
+- watir_api.gemspec
+homepage: https://github.com/titusfortner/watir_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.11
+signing_key: 
+specification_version: 4
+summary: A simple class for interacting with a Web App's API using test data
+test_files: []