synergy_wholesale 0.0.0

data/spec/integration/enable_auto_renewal_spec.rb

@@ -0,0 +1,52 @@
+require 'savon/mock/spec_helper'
+
+module SynergyWholesale
+  RSpec.describe EnableAutoRenewal do
+    include Savon::SpecHelper
+
+    # set Savon in and out of mock mode
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    def message(params)
+      core_params = API.new.adapter.params
+      { request: core_params.merge(params) }
+    end
+
+    describe 'EnableAutoRenewal' do
+      context 'when enabling succeeds' do
+
+        it 'is enabled' do
+          fixture = File.read('spec/fixtures/synergy/domain/autorenew/enable/success.xml')
+
+          savon
+            .expects(:enable_auto_renewal)
+            .with(message: message({ domain_name: 'bobsburgers.com.au' }))
+            .returns(fixture)
+
+          expect(EnableAutoRenewal.call(domain: { name: 'bobsburgers.com.au' }).is_enabled?).to be_truthy
+        end
+
+      end
+
+      context 'when enabling is not allowed' do
+
+        it 'raises a response error' do
+          fixture = File.read('spec/fixtures/synergy/domain/autorenew/enable/failure.xml')
+
+          savon
+            .expects(:enable_auto_renewal)
+            .with(message: message({ domain_name: 'google.com' }))
+            .returns(fixture)
+
+          expect {
+            EnableAutoRenewal.call(domain: { name: 'google.com' })
+          }.to raise_error(Errors::ResponseError, 'Reseller is not authorized to perform any functions on this domain')
+        end
+
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'synergy_wholesale'
+
+SPEC_ROOT = Pathname(__dir__)
+
+Dir[SPEC_ROOT.join('shared/**/*.rb')].each(&method(:require))
+Dir[SPEC_ROOT.join('support/**/*.rb')].each(&method(:require))
+
+SynergyWholesale.configure do |config|
+  config.reseller_id = '123'
+  config.api_key     = '123'
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/adapter_spec.rb

@@ -0,0 +1,97 @@
+require 'synergy_wholesale/adapter'
+
+RSpec.describe SynergyWholesale::Adapter do
+
+  describe '#client' do
+    it 'is a configured Savon client' do
+      adapter = SynergyWholesale::Adapter.new
+      expect(adapter.client).to be_an_instance_of(Savon::Client)
+      expect(adapter.client.globals[:wsdl]).to eq 'https://api.synergywholesale.com/server.php?wsdl'
+    end
+  end
+
+  describe '#params' do
+    it 'defaults to having the reseller id and api key' do
+      adapter = SynergyWholesale::Adapter.new
+      expect(adapter.params).to eq(
+                                  {
+                                    'resellerID' => '123',
+                                    'apiKey'     => '123'
+                                  }
+                                )
+    end
+  end
+
+  describe '#add_param' do
+    it 'modifies the params hash' do
+      adapter = SynergyWholesale::Adapter.new
+      expect {
+        adapter.add_param('foo', 'bar')
+      }.to change(adapter, :params)
+    end
+
+    it 'adds the param to the hash' do
+      adapter = SynergyWholesale::Adapter.new
+      adapter.add_param('foo', 'bar')
+      expect(adapter.params['foo']).to eq 'bar'
+    end
+  end
+
+  describe '#add_params' do
+    context 'when no params are sent' do
+      it 'no-ops' do
+        adapter = SynergyWholesale::Adapter.new
+        expect {
+          adapter.add_params
+        }.not_to change(adapter, :params)
+      end
+    end
+
+    context 'when non-hash values are sent' do
+      it 'raises an exception' do
+        adapter = SynergyWholesale::Adapter.new
+        expect {
+          adapter.add_params('foo', 'bar')
+        }.to raise_error(Exception, 'params are required to be key/value combinations')
+      end
+    end
+
+    context 'when a hash is sent' do
+      it 'modifies the params hash' do
+        adapter = SynergyWholesale::Adapter.new
+        expect {
+          adapter.add_params(foo: 'bar')
+        }.to change(adapter, :params)
+      end
+
+      it 'merges the params into the hash' do
+        adapter = SynergyWholesale::Adapter.new
+        adapter.add_params(foo: 'bar', bar: 'baz')
+        expect(adapter.params[:foo]).to eq 'bar'
+        expect(adapter.params[:bar]).to eq 'baz'
+        expect(adapter.params['resellerID']).to eq '123'
+      end
+    end
+  end
+
+  describe '#call' do
+    it 'delegates to the client, passing in required params' do
+      adapter = SynergyWholesale::Adapter.new
+      client  = instance_spy('Savon::Client')
+      adapter.instance_variable_set(:'@client', client)
+
+      adapter.call(:foo)
+
+      expect(client).to have_received(:call).with(
+        :foo,
+        message: {
+          request: {
+            'resellerID' => '123',
+            'apiKey'     => '123'
+          }
+        }
+      )
+    end
+  end
+
+end

data/spec/unit/api_spec.rb

@@ -0,0 +1,42 @@
+require 'synergy_wholesale/api'
+
+RSpec.describe SynergyWholesale::API do
+
+  describe '#call' do
+    context 'when the response class exists' do
+      module SynergyWholesale
+        class Foo < Operation
+          Command = Struct.new(:foo) do
+            def to_param
+              { foo: foo }
+            end
+            def operation
+              :foo
+            end
+          end
+          Response = Struct.new(:response, :soap_command)
+        end
+      end
+
+      it 'adds params to the adapter' do
+        adapter     = instance_spy('SynergyWholesale::Adapter', call: double('response', body: { foo_response: {} }))
+        api         = SynergyWholesale::API.new
+        api.adapter = adapter
+        api.call(SynergyWholesale::Foo::Command.new(:foo))
+
+        expect(adapter).to have_received(:add_params).with({ foo: :foo })
+      end
+
+      it 'returns a response object' do
+        adapter     = instance_spy('SynergyWholesale::Adapter', call: double('response', body: { foo_response: {} }))
+        api         = SynergyWholesale::API.new
+        api.adapter = adapter
+        response    = api.call(SynergyWholesale::Foo::Command.new(:foo))
+
+        expect(response).to be_an_instance_of(SynergyWholesale::Foo::Response)
+      end
+    end
+
+  end
+
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,44 @@
+require 'synergy_wholesale/configuration'
+
+RSpec.describe SynergyWholesale::Configuration do
+
+  class Dummy
+    extend SynergyWholesale::Configuration
+  end
+
+  before(:each) do
+    Dummy.api_key     = nil
+    Dummy.reseller_id = nil
+  end
+
+  describe '.reseller_id' do
+    context 'when not set' do
+      it 'raises an exception' do
+        expect { Dummy.reseller_id }.to raise_error(Exception, 'You need to provide a reseller ID to use the Synergy Wholesale API')
+      end
+    end
+
+    context 'when set' do
+      it 'returns the reseller id' do
+        Dummy.reseller_id = '123'
+        expect(Dummy.reseller_id).to eq '123'
+      end
+    end
+  end
+
+  describe '.api_key' do
+    context 'when not set' do
+      it 'raises an exception' do
+        expect { Dummy.api_key }.to raise_error(Exception, 'You need to provide an API Key to use the Synergy Wholesale API')
+      end
+    end
+
+    context 'when set' do
+      it 'returns the api key' do
+        Dummy.api_key = '123'
+        expect(Dummy.api_key).to eq '123'
+      end
+    end
+  end
+
+end

data/spec/unit/response_generator_spec.rb

@@ -0,0 +1,35 @@
+require 'synergy_wholesale/response_generator'
+
+RSpec.describe SynergyWholesale::ResponseGenerator do
+
+  describe '#build_response' do
+    context 'when class exists' do
+      module SynergyWholesale
+        module Responses
+          Foo = Struct.new(:response, :soap_command)
+        end
+      end
+
+      it 'returns an instance of the response class' do
+        response_generator = SynergyWholesale::ResponseGenerator.new
+        expect(
+          response_generator.build_response(
+            'SynergyWholesale::Commands::Foo',
+            'response',
+            'soap_command'
+          )
+        ).to be_an_instance_of(::SynergyWholesale::Responses::Foo)
+      end
+    end
+
+    context 'when class does not exist' do
+      it 'raises an exception' do
+        response_generator = SynergyWholesale::ResponseGenerator.new
+        expect {
+          response_generator.build_response('SynergyWholesale::Commands::Bar', 'response', 'soap_command')
+        }.to raise_error(NameError, 'uninitialized constant SynergyWholesale::Responses::Bar')
+      end
+    end
+  end
+
+end

data/synergy_wholesale.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+require File.expand_path('../lib/synergy_wholesale/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'synergy_wholesale'
+  spec.version       = SynergyWholesale::VERSION
+  spec.authors       = ['Rob Jacoby']
+  spec.email         = ['rob@robjacoby.com.au']
+  spec.summary       = 'A wrapper around the synergy wholesale reseller API'
+  spec.homepage      = 'https://github.com/robjacoby/synergy_wholesale'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0") - ['bin/console']
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_runtime_dependency 'savon', '~> 2.11.0'
+  spec.add_runtime_dependency 'dry-validation', '~> 0.10.3'
+  spec.add_runtime_dependency 'dry-struct', '~> 0.1.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: synergy_wholesale
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rob Jacoby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- rob@robjacoby.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/synergy_wholesale.rb
+- lib/synergy_wholesale/adapter.rb
+- lib/synergy_wholesale/api.rb
+- lib/synergy_wholesale/base_response.rb
+- lib/synergy_wholesale/configuration.rb
+- lib/synergy_wholesale/errors.rb
+- lib/synergy_wholesale/errors/bad_data_error.rb
+- lib/synergy_wholesale/errors/error.rb
+- lib/synergy_wholesale/errors/response_error.rb
+- lib/synergy_wholesale/inflector.rb
+- lib/synergy_wholesale/operation.rb
+- lib/synergy_wholesale/operations/check_domain.rb
+- lib/synergy_wholesale/operations/disable_auto_renewal.rb
+- lib/synergy_wholesale/operations/domain_register.rb
+- lib/synergy_wholesale/operations/domain_register_au.rb
+- lib/synergy_wholesale/operations/enable_auto_renewal.rb
+- lib/synergy_wholesale/response_generator.rb
+- lib/synergy_wholesale/types.rb
+- lib/synergy_wholesale/types/au_contact.rb
+- lib/synergy_wholesale/types/au_domain.rb
+- lib/synergy_wholesale/types/au_id_type.rb
+- lib/synergy_wholesale/types/au_organisation_type.rb
+- lib/synergy_wholesale/types/au_postcode.rb
+- lib/synergy_wholesale/types/au_registrant.rb
+- lib/synergy_wholesale/types/au_state.rb
+- lib/synergy_wholesale/types/contact.rb
+- lib/synergy_wholesale/types/country.rb
+- lib/synergy_wholesale/types/domain.rb
+- lib/synergy_wholesale/types/domain_list.rb
+- lib/synergy_wholesale/types/email.rb
+- lib/synergy_wholesale/types/phone.rb
+- lib/synergy_wholesale/types/registration_years.rb
+- lib/synergy_wholesale/version.rb
+- spec/fixtures/synergy/domain/autorenew/disable/failure.xml
+- spec/fixtures/synergy/domain/autorenew/disable/success.xml
+- spec/fixtures/synergy/domain/autorenew/enable/failure.xml
+- spec/fixtures/synergy/domain/autorenew/enable/success.xml
+- spec/fixtures/synergy/domain/available/example.com.xml
+- spec/fixtures/synergy/domain/available/ljsdlksdlfkmsldlskmlskmdlfkjlskjdlmlknlks.com.xml
+- spec/fixtures/synergy/domain/register/au/failure.xml
+- spec/fixtures/synergy/domain/register/au/success.xml
+- spec/fixtures/synergy/domain/register/failure.xml
+- spec/fixtures/synergy/domain/register/success.xml
+- spec/integration/check_domain_spec.rb
+- spec/integration/disable_auto_renewal_spec.rb
+- spec/integration/domain_register_au_spec.rb
+- spec/integration/domain_register_spec.rb
+- spec/integration/enable_auto_renewal_spec.rb
+- spec/spec_helper.rb
+- spec/unit/adapter_spec.rb
+- spec/unit/api_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/response_generator_spec.rb
+- synergy_wholesale.gemspec
+homepage: https://github.com/robjacoby/synergy_wholesale
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A wrapper around the synergy wholesale reseller API
+test_files:
+- spec/fixtures/synergy/domain/autorenew/disable/failure.xml
+- spec/fixtures/synergy/domain/autorenew/disable/success.xml
+- spec/fixtures/synergy/domain/autorenew/enable/failure.xml
+- spec/fixtures/synergy/domain/autorenew/enable/success.xml
+- spec/fixtures/synergy/domain/available/example.com.xml
+- spec/fixtures/synergy/domain/available/ljsdlksdlfkmsldlskmlskmdlfkjlskjdlmlknlks.com.xml
+- spec/fixtures/synergy/domain/register/au/failure.xml
+- spec/fixtures/synergy/domain/register/au/success.xml
+- spec/fixtures/synergy/domain/register/failure.xml
+- spec/fixtures/synergy/domain/register/success.xml
+- spec/integration/check_domain_spec.rb
+- spec/integration/disable_auto_renewal_spec.rb
+- spec/integration/domain_register_au_spec.rb
+- spec/integration/domain_register_spec.rb
+- spec/integration/enable_auto_renewal_spec.rb
+- spec/spec_helper.rb
+- spec/unit/adapter_spec.rb
+- spec/unit/api_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/response_generator_spec.rb