remote_database_cleaner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b0e61e8e2d3f185a306b10762b53afeb0e25033
+  data.tar.gz: f989f626027a228d0920675b776f5bc5c8a81f73
+SHA512:
+  metadata.gz: 231565a9970f00fe2328679da6b026b71a8f0698a900c938206a4b214778abb1978d23971b1b08e590971f053eb598686ab7e2d2895030c77a8ae3a5a241bd46
+  data.tar.gz: 48c05cfce55d1a28a241d8770a0f9daf6f039090d7711a9dfd4b2a9638ac6e8bf56d6a328e99c328bb23151cb74b2c72f3df9fb923a44c4ceffde004c675ff0c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--default_path spec

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rest-client' # http
+gem 'virtus', '~> 1.0' # defining attributes on a model: strong typing like objects and defaults
+
+# Specify your gem's dependencies in remote_database_cleaner.gemspec
+gemspec
+
+gem 'rspec'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tdouce
+
+MIT License
+
+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,19 @@
+# RemoteDatabaseCleaner
+
+[database_cleaner](https://github.com/bmabey/database_cleaner) for [Software Oriented Architecture](http://en.wikipedia.org/wiki/Service-oriented_architecture) (SOA). Clean
+database remotely when used in conjunction with [remote_database_cleaner_home_rails](https://github.com/tdouce/remote_database_cleaner_home_rails).
+
+## Getting Started
+
+See [GETTING STARTED](https://github.com/tdouce/remote_database_cleaner/wiki/Getting-Started)
+
+## Run Tests
+    $ rspec
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/remote_database_cleaner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/remote_database_cleaner/config.rb

@@ -0,0 +1,52 @@
+require 'remote_database_cleaner/exceptions'
+require 'virtus'
+
+module RemoteDatabaseCleaner
+  class Config
+    include Virtus.model
+
+    DEFAULT_HOME_CONFIG = { :host      => nil, 
+                            :port      => nil, 
+                            :end_point => '/remote_database_cleaner/home/clean' }
+
+    attribute :home, Hash, :default => DEFAULT_HOME_CONFIG
+
+    def self.configure(configs)
+      new(configs)
+    end
+
+    def initialize(attrs = {})
+      attrs[:home] = update_home_config(attrs)
+      super(attrs)
+    end
+
+    def home_url
+      raise_no_host_error
+      http = 'http://'
+      if home[:port]
+        "#{ http }#{ home.fetch(:host) }:#{ home.fetch(:port) }#{ home.fetch(:end_point) }"
+      else
+        "#{ http }#{ home.fetch(:host) }#{ home.fetch(:end_point) }"
+      end
+    end
+
+    def to_hash
+      raise_no_host_error
+      super.merge(home_url: home_url)
+    end
+
+    def raise_no_host_error
+      raise RemoteDatabaseCleanerConfigError.new("RemoteDatabaseCleaner.config.home[:host] can not be nil") unless has_home?
+    end
+
+    def has_home?
+      !home[:host].nil? && !(home[:host] == '') && !home[:end_point].nil? && !(home[:end_point] == '')
+    end
+
+    private
+
+    def update_home_config(attrs)
+      attrs[:home] = DEFAULT_HOME_CONFIG.merge(attrs.fetch(:home, {}))
+    end
+  end
+end

data/lib/remote_database_cleaner/config_struct.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+module RemoteDatabaseCleaner
+  class ConfigStruct < OpenStruct
+    def self.block_to_hash(block = nil)
+      config = self.new
+      if block
+        block.call(config)
+        config.to_hash
+      else
+        {}
+      end
+    end
+   
+    def to_hash
+      @table
+    end
+  end
+end

data/lib/remote_database_cleaner/exceptions.rb

@@ -0,0 +1,3 @@
+module RemoteDatabaseCleaner
+  class RemoteDatabaseCleanerConfigError < StandardError; end
+end

data/lib/remote_database_cleaner/http.rb

@@ -0,0 +1,14 @@
+require 'rest-client'
+
+module RemoteDatabaseCleaner
+  class Http
+    def self.post(config, params, rest_client = RestClient)
+      new.post(config, params, rest_client)
+    end
+
+    def post(config, params, rest_client)
+      config.raise_no_host_error
+      rest_client.post config.home_url, params, content_type: :json, accept: :json
+    end
+  end
+end

data/lib/remote_database_cleaner/version.rb

@@ -0,0 +1,3 @@
+module RemoteDatabaseCleaner
+  VERSION = "0.0.1"
+end

data/lib/remote_database_cleaner.rb

@@ -0,0 +1,34 @@
+require "remote_database_cleaner/version"
+require 'remote_database_cleaner/config'
+require 'remote_database_cleaner/http'
+require 'remote_database_cleaner/config_struct'
+
+module RemoteDatabaseCleaner
+  class RemoteDatabaseCleaner
+    def params 
+      { :database => :clean }
+    end
+  end
+
+  def self.configure(opts = { :config_struct => ConfigStruct, :config => Config }, &block)
+    config      = opts.fetch(:config_struct).block_to_hash(block)
+    self.config = opts.fetch(:config).configure(config)
+  end
+
+  def self.clean(http = Http)
+    database_cleaner = RemoteDatabaseCleaner.new
+    http.post(config, database_cleaner.params)
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.reset(config = Config.new)
+    self.config = config
+  end
+end

data/remote_database_cleaner.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remote_database_cleaner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remote_database_cleaner"
+  spec.version       = RemoteDatabaseCleaner::VERSION
+  spec.authors       = ["tdouce"]
+  spec.email         = ["travisdouce@gmail.com"]
+  spec.summary       = %q{Initiate cleaning of test database in server from client }
+  spec.description   = %q{Faciliates SOA (software oriented architecture) integration testing.}
+  spec.homepage      = "https://github.com/tdouce/remote_database_cleaner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'rest-client'
+end

data/spec/integration/remote_database_cleaner_spec.rb

@@ -0,0 +1,53 @@
+require 'remote_database_cleaner'
+
+describe RemoteDatabaseCleaner do
+
+  before { RemoteDatabaseCleaner.reset }
+
+  describe 'configuration' do
+    it 'should be configured with correct defaults' do
+      expect(RemoteDatabaseCleaner.config.home).to eq({:host      => nil, 
+                                                       :port      => nil, 
+                                                       :end_point => '/remote_database_cleaners'})
+    end
+
+    it 'should be able to configure with a block' do
+      RemoteDatabaseCleaner.configure do |config|
+        config.home = { host: 'tifton' }
+      end
+      expect(RemoteDatabaseCleaner.config.home[:host]).to eq('tifton')
+    end
+
+    it 'should be able to configure .home' do
+      RemoteDatabaseCleaner.config.home[:host] = 'fun_guy'
+      RemoteDatabaseCleaner.config.home[:port] = 3333 
+      RemoteDatabaseCleaner.config.home[:end_point] = '/down_home' 
+      expect(RemoteDatabaseCleaner.config.home[:host]).to eq('fun_guy')
+      expect(RemoteDatabaseCleaner.config.home[:port]).to eq(3333)
+      expect(RemoteDatabaseCleaner.config.home[:end_point]).to eq('/down_home')
+    end
+  end
+
+  describe 'errors' do
+    it 'should raise RemoteDatabaseCleanerConfigError if .config.home[:host] is nil' do
+      RemoteDatabaseCleaner.config.home[:host] = nil
+      expect { RemoteDatabaseCleaner.clean }.to raise_error(RemoteDatabaseCleaner::RemoteDatabaseCleanerConfigError)
+    end
+
+    it 'should raise RemoteDatabaseCleanerConfigError if .config.home[:end_point] is nil' do
+      RemoteDatabaseCleaner.config.home[:end_point] = nil
+      expect { RemoteDatabaseCleaner.clean }.to raise_error(RemoteDatabaseCleaner::RemoteDatabaseCleanerConfigError)
+    end
+  end
+
+  describe '.clean' do
+    it 'should send a post request to home' do
+      RemoteDatabaseCleaner::Http.stub(:post).and_return(true)
+      RemoteDatabaseCleaner.config.home[:host] = 'localhost'
+      config = RemoteDatabaseCleaner.config
+      params = { :database => :clean }
+      expect(RemoteDatabaseCleaner::Http).to receive(:post).with(config, params) 
+      RemoteDatabaseCleaner.clean
+    end
+  end
+end

data/spec/models/remote_database_cleaner/config_spec.rb

@@ -0,0 +1,55 @@
+require 'virtus'
+require 'remote_database_cleaner/config'
+require 'remote_database_cleaner/exceptions'
+
+describe RemoteDatabaseCleaner::Config do
+
+  let(:default_config) { RemoteDatabaseCleaner::Config.new }
+
+  describe 'initialize' do
+
+    describe 'default configuration' do
+      it 'should be configured with correct defaults' do
+        default_config = RemoteDatabaseCleaner::Config.new
+        expect(default_config.home).to eq({ :host      => nil, 
+                                            :port      => nil, 
+                                            :end_point => '/remote_database_cleaners'})
+      end
+    end
+
+    describe '.configure' do
+      it 'should be able to set configurations' do
+        config  = RemoteDatabaseCleaner::Config.configure({ :home => { :host => 'tifton', :port => 9999, :end_point => '/somewhere' }})
+        expect(config.home).to eq({ :host      => 'tifton', 
+                                    :port      => 9999, 
+                                    :end_point => '/somewhere'})
+      end
+    end
+
+    describe '#home_url' do
+      it 'should return a url with port if port is configured' do
+        default_config.home[:host] = 'localhost'
+        default_config.home[:port] = 5555
+        expect(default_config.home_url).to eq('http://localhost:5555/remote_database_cleaners')
+      end
+
+      it 'should return a url without a port if port is not configured' do
+        default_config.home[:host] = 'localhost_no_port'
+        default_config.home[:port] = nil 
+        expect(default_config.home_url).to eq('http://localhost_no_port/remote_database_cleaners')
+      end
+    end
+
+    describe 'errors' do
+      it 'should raise RemoteDatabaseConfigError if .config.home[:host] is nil' do
+        default_config.home[:host] = nil
+        expect { default_config.to_hash }.to raise_error(RemoteDatabaseCleaner::RemoteDatabaseCleanerConfigError)
+      end
+
+      it 'should raise RemoteDatabaseConfigError if .config.home[:end_point] is nil' do
+        default_config.home[:end_point] = nil
+        expect { default_config.to_hash }.to raise_error(RemoteDatabaseCleaner::RemoteDatabaseCleanerConfigError)
+      end
+    end
+  end
+end

data/spec/models/remote_database_cleaner/config_struct_spec.rb

@@ -0,0 +1,21 @@
+require 'remote_database_cleaner/config_struct.rb'
+
+describe RemoteDatabaseCleaner::ConfigStruct do
+
+  describe '.block_to_hash' do
+    it 'should be able to configure with a block' do
+      class Thing
+        def self.configure(&block)
+          RemoteDatabaseCleaner::ConfigStruct.block_to_hash(block)
+        end
+      end
+
+      thing = Thing.configure do |config|
+        config.first_name = 'Sam' 
+        config.last_name  = 'Iam' 
+      end
+
+      expect(thing.to_hash).to eq({:first_name => 'Sam', :last_name => 'Iam'})
+    end
+  end
+end

data/spec/models/remote_database_cleaner/http_spec.rb

@@ -0,0 +1,23 @@
+require 'remote_database_cleaner/http.rb'
+
+describe RemoteDatabaseCleaner::Http do
+
+  describe '.post' do
+
+    let(:config) { double(:home_url => 'http://somewhere') }
+    let(:params) { double(:first_name => 'Sam', :last_name => 'Iam') }
+    let(:rest_client) { double('RestClient') }
+
+    it 'should raise no host config errors' do
+      rest_client.stub(:post).with(config.home_url, params, content_type: :json, accept: :json).and_return(true)
+      expect(config).to receive(:raise_no_host_error) 
+      RemoteDatabaseCleaner::Http.post(config, params, rest_client)
+    end
+
+    it 'should send http request to home_url with params' do
+      config.stub(:raise_no_host_error)
+      expect(rest_client).to receive(:post).with(config.home_url, params, content_type: :json, accept: :json) 
+      RemoteDatabaseCleaner::Http.post(config, params, rest_client)
+    end
+  end
+end

data/spec/models/remote_database_cleaner_spec.rb

@@ -0,0 +1,39 @@
+require 'remote_database_cleaner'
+
+describe RemoteDatabaseCleaner do
+  it 'should return params for http request' do
+    rfg = RemoteDatabaseCleaner::RemoteDatabaseCleaner.new
+    expect(rfg.params).to eq({ :database => :clean })
+  end
+
+  it 'should be able to configure with a block' do
+    pending
+  end
+
+  describe '.config' do
+    it 'should be able to set and get config' do
+      config = double('config')
+      RemoteDatabaseCleaner.config = config
+      expect(RemoteDatabaseCleaner.config).to equal(config)
+    end
+  end
+
+  describe '.reset' do
+    it 'should be able to reset the configuration' do
+      config = double('config')
+      RemoteDatabaseCleaner.config = config
+      RemoteDatabaseCleaner.reset(double('config'))
+      expect(RemoteDatabaseCleaner.config).to_not equal(config)
+    end
+  end
+
+  describe '.clean' do
+    it 'should send http request and parse request' do
+      config = double('config', :home_url => 'http://somewhere', :to_hash => {})
+      http   = double('RemoteDatabaseCleaner::Http', :post => {})
+      RemoteDatabaseCleaner.config = config
+      expect(http).to receive(:post).with(config, { :database => :clean })
+      RemoteDatabaseCleaner.clean(http)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+# our gem
+require 'remote_database_cleaner'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: remote_database_cleaner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tdouce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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'
+description: Faciliates SOA (software oriented architecture) integration testing.
+email:
+- travisdouce@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/remote_database_cleaner.rb
+- lib/remote_database_cleaner/config.rb
+- lib/remote_database_cleaner/config_struct.rb
+- lib/remote_database_cleaner/exceptions.rb
+- lib/remote_database_cleaner/http.rb
+- lib/remote_database_cleaner/version.rb
+- remote_database_cleaner.gemspec
+- spec/integration/remote_database_cleaner_spec.rb
+- spec/models/remote_database_cleaner/config_spec.rb
+- spec/models/remote_database_cleaner/config_struct_spec.rb
+- spec/models/remote_database_cleaner/http_spec.rb
+- spec/models/remote_database_cleaner_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tdouce/remote_database_cleaner
+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: Initiate cleaning of test database in server from client
+test_files:
+- spec/integration/remote_database_cleaner_spec.rb
+- spec/models/remote_database_cleaner/config_spec.rb
+- spec/models/remote_database_cleaner/config_struct_spec.rb
+- spec/models/remote_database_cleaner/http_spec.rb
+- spec/models/remote_database_cleaner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: