splicer-dynect 0.0.1

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
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+splicer-dynect

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in splicer-dynect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Johnston
+
+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,30 @@
+# Splicer::Dynect
+
+A Splicer adapter to interact with Dynect.
+
+
+## Installation
+
+```sh
+gem install splicer
+gem install splicer-dynect
+```
+
+## Using
+
+It's fairly easy to set up. Simply register it with Splicer and everything
+should work good.
+
+```rb
+Splicer.configure do |config|
+  config.register(Splicer::Dynect::Config.new('customer','user','pass'))
+end
+```
+
+
+## Contributing
+
+  * Fork it
+  * Create a feature branch
+  * Submit a pull request
+  * Wait for feedback and possible merge

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/splicer/dynect/client.rb

@@ -0,0 +1,137 @@
+module Splicer
+  module Dynect
+
+    class Client
+      attr_reader :base_url, :headers, :customer, :username, :password
+
+      def initialize(customer, username, password)
+        @customer = customer
+        @username = username
+        @password = password
+
+        @base_url = 'https://api-v4.dynect.net/REST'
+        @headers  = {
+          'Content-Type' => 'application/json',
+          'API-Version'  => '3.4.0'
+        }
+      end
+
+      # @param [String] resource
+      # @param [Hash] payload
+      #
+      # @return [Hash]
+      def post(resource, payload={})
+        execute({
+          method: :post,
+          url: resource_url(resource),
+          payload: payload.to_json,
+          headers: @headers,
+          max_redirects: 20
+        })
+      rescue RestClient::Exception => error
+        raise Splicer::Errors::RequestError.new(error)
+      end
+
+      # @param [String] resource
+      #
+      # @return [Hash]
+      def get(resource)
+        execute({
+          method: :get,
+          url: resource_url(resource),
+          headers: @headers,
+          max_redirects: 20
+        })
+      rescue RestClient::Exception => error
+        raise Splicer::Errors::RequestError.new(error)
+      end
+
+      # @param [String] resource
+      # @param [Hash] payload
+      #
+      # @return [Hash]
+      def put(resource, payload={})
+        execute({
+          method: :put,
+          url: resource_url(resource),
+          payload: payload.to_json,
+          headers: @headers
+        })
+      rescue RestClient::Exception => error
+        raise Splicer::Errors::RequestError.new(error)
+      end
+
+      # @param [String] resource
+      #
+      # @return [Hash]
+      def delete(resource)
+        execute({
+          method: :delete,
+          url: resource_url(resource),
+          headers: @headers
+        })
+      rescue RestClient::Exception => error
+        raise Splicer::Errors::RequestError.new(error)
+      end
+
+      # Creates a client's session
+      #
+      # @return [Boolean]
+      def login
+        return true if logged_in?
+
+        resp = post('Session', {
+          user_name: @username,
+          password: @password,
+          customer_name: @customer
+        })
+        @headers['Auth-Token'] = resp['data']['token']
+        true
+      end
+
+      # Keeps the session alive
+      #
+      # @return [Boolean] True if successful
+      def noop
+        return false unless logged_in?
+
+        put('Session')
+        true
+      end
+
+      # Destroys the client's session
+      #
+      # @return [Boolean]
+      def logout
+        return false unless logged_in?
+        delete('Session')
+        @headers.delete('Auth-Token')
+        true
+      end
+
+      private
+
+      # @return [Boolean]
+      def logged_in?
+        !!@headers['Auth-Token']
+      end
+
+      # Wrapper around RestClient::Request.execute method
+      #
+      # @param [Hash] args
+      # @raise [Splicer::Errors::RequestError] when the request fails
+      # @return [Hash]
+      def execute(args={})
+        JSON.parse(RestClient::Request.execute(args))
+      rescue RestClient::Exception => error
+        raise Splicer::Errors::RequestError.new(error)
+      end
+
+      def resource_url resource
+        [@base_url, resource.gsub(/^\//,'').gsub(/REST\//,'')].join('/')
+      end
+
+    end
+
+  end
+end

data/lib/splicer/dynect/config.rb

@@ -0,0 +1,21 @@
+module Splicer
+  module Dynect
+
+    # A simple configuration data structure
+    # @author Matthew A. Johnston <warmwaffles@gmail.com>
+    class Config
+      attr_reader :username, :password, :customer
+
+      def initialize(customer, username, password)
+        @customer = customer
+        @username = username
+        @password = password
+      end
+
+      def provider
+        Provider.new(self)
+      end
+    end
+
+  end
+end

data/lib/splicer/dynect/provider.rb

@@ -0,0 +1,20 @@
+module Splicer
+  module Dynect
+
+    class Provider
+      def initialize(config)
+        @client = Client.new(config.customer, config.username, config.password)
+      end
+
+      def publish(zone, method)
+        @client.login
+
+        # Merge zone
+        # Publish zone
+
+        @client.logout
+      end
+    end
+
+  end
+end

data/lib/splicer/dynect/version.rb

@@ -0,0 +1,5 @@
+module Splicer
+  module Dynect
+    VERSION = "0.0.1"
+  end
+end

data/lib/splicer/dynect.rb

@@ -0,0 +1,15 @@
+require 'splicer'
+
+require 'json'
+require 'restclient'
+
+require 'splicer/dynect/version'
+require 'splicer/dynect/config'
+require 'splicer/dynect/provider'
+require 'splicer/dynect/client'
+
+module Splicer
+  module Dynect
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'splicer'
+require 'splicer/dynect'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/splicer/dynect/client_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Splicer::Dynect::Client do
+  let(:client) { Splicer::Dynect::Client.new('customer','username','password') }
+  describe '#initialize' do
+    subject { client }
+    its(:customer) { should eq('customer') }
+    its(:username) { should eq('username') }
+    its(:password) { should eq('password') }
+    its(:base_url) { should eq('https://api-v4.dynect.net/REST') }
+  end
+
+  describe '#post' do
+    subject { client.post('resource', { data: 'something' }) }
+
+    context 'when Dynect returns with success' do
+      before { client.stub(:execute).and_return({}) }
+      it { should eq({})}
+    end
+
+    context 'when Dynect returns with an error' do
+      before { client.stub(:execute).and_raise(RestClient::Exception.new) }
+      it 'should raise a Splicer::Errors::RequestError' do
+        expect { subject }.to raise_error(Splicer::Errors::RequestError)
+      end
+    end
+  end
+
+  describe '#get' do
+    subject { client.get('resource') }
+
+    context 'when Dynect returns with success' do
+      before { client.stub(:execute).and_return({}) }
+      it { should eq({})}
+    end
+
+    context 'when Dynect returns with an error' do
+      before { client.stub(:execute).and_raise(RestClient::Exception.new) }
+      it 'should raise a Splicer::Errors::RequestError' do
+        expect { subject }.to raise_error(Splicer::Errors::RequestError)
+      end
+    end
+  end
+
+  describe '#put' do
+    subject { client.put('resource', { data: 'something' }) }
+
+    context 'when Dynect returns with success' do
+      before { client.stub(:execute).and_return({}) }
+      it { should eq({})}
+    end
+
+    context 'when Dynect returns with an error' do
+      before { client.stub(:execute).and_raise(RestClient::Exception.new) }
+      it 'should raise a Splicer::Errors::RequestError' do
+        expect { subject }.to raise_error(Splicer::Errors::RequestError)
+      end
+    end
+  end
+
+  describe '#delete' do
+    subject { client.delete('resource') }
+
+    context 'when Dynect returns with success' do
+      before { client.stub(:execute).and_return({}) }
+      it { should eq({})}
+    end
+
+    context 'when Dynect returns with an error' do
+      before { client.stub(:execute).and_raise(RestClient::Exception.new) }
+      it 'should raise a Splicer::Errors::RequestError' do
+        expect { subject }.to raise_error(Splicer::Errors::RequestError)
+      end
+    end
+  end
+
+  describe '#login' do
+    subject { client.login }
+
+    context 'when logged in' do
+      before { client.stub(:logged_in?).and_return(true) }
+      it { should eq(true) }
+    end
+
+    context 'when not logged in' do
+      let(:data) { {'data' => {'token' => 'blah'}} }
+      before { client.stub(:post).and_return(data) }
+
+      it { should eq(true) }
+      it 'should set the Auth-Token' do
+        subject
+        expect(client.headers['Auth-Token']).to eq('blah')
+      end
+    end
+  end
+
+  describe '#noop' do
+    subject { client.noop }
+
+    context 'when logged in' do
+      before do
+        client.stub(:logged_in?).and_return(true)
+        client.stub(:put).and_return({})
+      end
+      it { should eq(true) }
+    end
+
+    context 'when not logged in' do
+      before { client.stub(:logged_in?).and_return(false) }
+      it { should eq(false) }
+    end
+  end
+
+  describe '#logout' do
+    subject { client.logout }
+
+    context 'when logged in' do
+      before do
+        client.headers['Auth-Token'] = 'blah'
+        client.stub(:delete).and_return({})
+      end
+      it { should eq(true) }
+      it 'should unset the Auth-Token' do
+        subject
+        expect(client.headers['Auth-Token']).to eq(nil)
+      end
+    end
+
+    context 'when not logged in' do
+      before { client.stub(:logged_in?).and_return(false) }
+      it { should eq(false) }
+    end
+  end
+end

data/spec/splicer/dynect/config_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Splicer::Dynect::Config do
+  let(:config) { Splicer::Dynect::Config.new('customer','user','password') }
+  describe '#initialize' do
+    subject { config }
+    its(:customer) { should eq('customer') }
+    its(:username) { should eq('user') }
+    its(:password) { should eq('password') }
+  end
+
+  describe '#provider' do
+    subject { config.provider }
+    it { should be_a(Splicer::Dynect::Provider) }
+  end
+end

data/spec/splicer/dynect/provider_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Splicer::Dynect::Provider do
+  pending
+end

data/splicer-dynect.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'splicer/dynect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "splicer-dynect"
+  spec.version       = Splicer::Dynect::VERSION
+  spec.authors       = ["Matthew Johnston"]
+  spec.email         = ["warmwaffles@gmail.com"]
+  spec.description   = %q{The splicer adapter for interacting Dynect}
+  spec.summary       = %q{The splicer adapter for interacting Dynect}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency('splicer')
+  spec.add_dependency('rest-client')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: splicer-dynect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: splicer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The splicer adapter for interacting Dynect
+email:
+- warmwaffles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/splicer/dynect.rb
+- lib/splicer/dynect/client.rb
+- lib/splicer/dynect/config.rb
+- lib/splicer/dynect/provider.rb
+- lib/splicer/dynect/version.rb
+- spec/spec_helper.rb
+- spec/splicer/dynect/client_spec.rb
+- spec/splicer/dynect/config_spec.rb
+- spec/splicer/dynect/provider_spec.rb
+- splicer-dynect.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2888442058802865494
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2888442058802865494
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: The splicer adapter for interacting Dynect
+test_files:
+- spec/spec_helper.rb
+- spec/splicer/dynect/client_spec.rb
+- spec/splicer/dynect/config_spec.rb
+- spec/splicer/dynect/provider_spec.rb