keepcon 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7a0fa69cc80ff684b2fa24dad62197c43797c5f
+  data.tar.gz: ce37f8ea76108fda5ef7f2f4f41094d50523330e
+SHA512:
+  metadata.gz: 33da2e6573ffbe5a42816e663a356f8bdd244f11006c6d1e5391ff6c315d9f1fc13d3cbf1f538c5888473b7cc371d9392bdaeab7d3f7cb7d6302c08e6cfe52d5
+  data.tar.gz: c9337e9353beb7ca87c8b8c91ca65c16bc3f39f3ef9a8aa716034cbba3bdefe38fda7fa68ab292e00667d468a3040cad945762bdc40389006b778d4ac2316870

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+git:
+  depth: 1
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+addons:
+  code_climate:
+    repo_token: 217146fc082e87b5e4b2352141a8832d0da78d66a9d22cb0b5189344648e821e

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Love Mondays Ltda
+
+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,43 @@
+# Keepcon
+
+
+[![Build Status](https://travis-ci.org/LoveMondays/keepcon.svg)](https://travis-ci.org/LoveMondays/keepcon)
+[![Code Climate](https://codeclimate.com/github/LoveMondays/keepcon/badges/gpa.svg)](https://codeclimate.com/github/LoveMondays/keepcon)
+[![Test Coverage](https://codeclimate.com/github/LoveMondays/keepcon/badges/coverage.svg)](https://codeclimate.com/github/LoveMondays/keepcon)
+[![Dependency Status](https://gemnasium.com/LoveMondays/keepcon.svg)](https://gemnasium.com/LoveMondays/keepcon)
+
+This is a Ruby wrapper for the [Keepcon](http://keepcon.com) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keepcon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keepcon
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/LoveMondays/keepcon/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:style)
+
+task default: [:spec, :style]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'keepcon'
+
+# 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

data/bin/setup

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

data/keepcon.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keepcon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'keepcon'
+  spec.version       = Keepcon::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Shane O'Grady"]
+  spec.email         = ['shane@ogrady.ie']
+
+  spec.summary       = 'Ruby wrapper for the Keepcon XML API'
+  spec.homepage      = 'https://github.com/LoveMondays/keepcon'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'retryable-rb'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'actionview'
+  spec.add_dependency 'gyoku'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/keepcon/client.rb

@@ -0,0 +1,47 @@
+module Keepcon
+  class Client
+    attr_accessor :user, :config
+    attr_writer :password
+
+    def initialize
+      self.config = {}
+      config['urls'] = YAML.load_file(urls_config_path)
+      config['client'] = YAML.load_file(client_config_path)
+      yield self if block_given?
+    end
+
+    def content_request(data, mode = :sync)
+      fail ArgumentError, 'The data can not be empty' unless data.present?
+
+      request(:put, config['urls']['content']['request'][mode.to_s], data, mode)
+    end
+
+    private
+
+    def request(method, path, data, mode = :sync)
+      connection(mode).send(method, path, data.to_s, headers)
+    end
+
+    def connection(mode = :sync)
+      Faraday.new(url: config['urls']['keepcon'][mode.to_s]).tap do |c|
+        c.basic_auth(user, @password)
+      end
+    end
+
+    def urls_config_path
+      File.expand_path('../config/urls.yml', __FILE__)
+    end
+
+    def client_config_path
+      File.expand_path('../config/client.yml', __FILE__)
+    end
+
+    def headers
+      { 'User-Agent' => user_agent }
+    end
+
+    def user_agent
+      config['client']['request']['headers']['user_agent'] % { user: user }
+    end
+  end
+end

data/lib/keepcon/config/client.yml

@@ -0,0 +1,3 @@
+request:
+  headers:
+    user_agent: 'Keepcon Client API REST v1.0 - Context Name: [%{user}]'

data/lib/keepcon/config/urls.yml

@@ -0,0 +1,9 @@
+keepcon:
+  sync: 'http://sync.keepcon.com'
+  async: 'http://service.keepcon.com'
+content:
+  request:
+    sync: '/synchronic/moderate'
+    async: '/input/contentSet'
+  response:
+    async: '/output/contentSet?contextName=%{context_name}'

data/lib/keepcon/context.rb

@@ -0,0 +1,39 @@
+module Keepcon
+  class Context
+    attr_accessor :user
+    attr_writer :password
+
+    def initialize(params = {})
+      @mappings = {}
+      map(params[:mappings])
+      params.except(:mappings).each { |k, v| send("#{k}=", v) }
+    end
+
+    def map(hash)
+      return unless hash.present?
+      hash.each { |k, v| add_mapping(k, v) }
+    end
+
+    def translate(attribute)
+      @mappings[attribute].try(:to)
+    end
+
+    def attribute_names
+      @mappings.keys
+    end
+
+    def client
+      @client ||= Client.new do |config|
+        config.user = user
+        config.password = @password
+      end
+    end
+
+    private
+
+    def add_mapping(from, to)
+      mapping = Mapping.new(from: from, to: to)
+      @mappings[mapping.from] = mapping
+    end
+  end
+end

data/lib/keepcon/entity/response.rb

@@ -0,0 +1,12 @@
+module Keepcon
+  class Entity
+    class Response
+      attr_accessor :status, :body
+
+      def initialize(http_response)
+        self.body = http_response.body
+        self.status = http_response.status
+      end
+    end
+  end
+end

data/lib/keepcon/entity.rb

@@ -0,0 +1,62 @@
+require 'gyoku'
+require 'action_view'
+
+require 'keepcon/entity/response'
+
+module Keepcon
+  class Entity
+    include ActionView::Helpers::TagHelper
+
+    attr_accessor :context, :instance
+
+    def initialize(params = {})
+      params.each { |k, v| send("#{k}=", v) }
+    end
+
+    def translate
+      translation = context.attribute_names.map do |attr_name|
+        [context.translate(attr_name), instance.send(attr_name)]
+      end
+      Hash[translation]
+    end
+
+    def to_xml
+      Gyoku.xml(xml_hash)
+    end
+
+    def send_data(mode = :sync)
+      parse_response(context.client.content_request(to_xml, mode))
+    end
+
+    private
+
+    def parse_response(response)
+      Response.new(response)
+    end
+
+    def xml_hash
+      {
+        import: {
+          contenttype: context.user,
+          contents: {
+            content: [
+              { :@id => instance.id }.merge(translate_to_xml_hash)
+            ]
+          }
+        }
+      }
+    end
+
+    def translate_to_xml_hash
+      translation = translate.map do |k, v|
+        case
+        when k == :datetime then [k, { content!: (v.to_f * 1_000).to_i }]
+        when k == :author then [k, { :@type => :author, :content! => v }]
+        when v.is_a?(Fixnum) then [k, { content!: v }]
+        else ["#{k}!", { content!: cdata_section(v) }]
+        end
+      end
+      Hash[translation]
+    end
+  end
+end

data/lib/keepcon/integration.rb

@@ -0,0 +1,35 @@
+module Keepcon
+  module Integration
+    def send_to_keepcon(context, mode = :sync)
+      keepcon_entity(context).send_data(mode)
+    end
+
+    def keepcon_entity(context)
+      Entity.new(context: context, instance: self)
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def keepcon_integration(context_name, mappings = {})
+        unless (context = find_context(context_name))
+          fail 'The context does not exist'
+        end
+
+        context.map(mappings)
+
+        define_method("send_#{context_name}_to_keepcon") do |mode = :sync|
+          send_to_keepcon(context, mode)
+        end
+      end
+
+      private
+
+      def find_context(context)
+        Keepcon.contexts[context]
+      end
+    end
+  end
+end

data/lib/keepcon/mapping.rb

@@ -0,0 +1,9 @@
+module Keepcon
+  class Mapping
+    attr_accessor :from, :to
+
+    def initialize(params = {})
+      params.each { |k, v| send("#{k}=", v) }
+    end
+  end
+end

data/lib/keepcon/rails.rb

@@ -0,0 +1,15 @@
+module Keepcon
+  class Rails
+    class << self
+      def setup!
+        add_integration(ActiveRecord::Base) if defined?(ActiveRecord::Base)
+      end
+
+      private
+
+      def add_integration(klass)
+        klass.send(:include, Integration) unless klass.include?(Integration)
+      end
+    end
+  end
+end

data/lib/keepcon/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Keepcon
+  VERSION = '0.1.1'
+end

data/lib/keepcon.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+require 'faraday'
+require 'active_support'
+require 'active_support/core_ext/object'
+
+require 'keepcon/client'
+require 'keepcon/context'
+require 'keepcon/entity'
+require 'keepcon/integration'
+require 'keepcon/mapping'
+require 'keepcon/rails'
+require 'keepcon/version'
+
+module Keepcon
+  mattr_accessor :contexts
+  self.contexts = {}
+
+  Rails.setup!
+
+  class << self
+    def setup
+      yield self
+    end
+
+    def add_context(name, params)
+      contexts[name] = Context.new(params)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Keepcon::Client do
+  let(:client) do
+    described_class.new do |config|
+      config.user = 'user'
+      config.password = 'password'
+    end
+  end
+
+  describe '.new' do
+    it 'passes the self to the block' do
+      described_class.new do |config|
+        expect(config.class).to eq(described_class)
+      end
+    end
+  end
+
+  describe '#content_request' do
+    subject { client.content_request(data, mode) }
+
+    let(:adapter) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.put('/synchronic/moderate', 'data', headers) do |_env|
+          [200, {}, 'sync']
+        end
+        stub.put('/input/contentSet', 'data', headers) do |_env|
+          [200, {}, 'async']
+        end
+      end
+    end
+    let(:headers) do
+      {
+        'User-Agent' => 'Keepcon Client API REST v1.0 - Context Name: [user]',
+        'Authorization' => 'Basic dXNlcjpwYXNzd29yZA=='
+      }
+    end
+    let!(:faraday) { Faraday.new { |f| f.adapter :test, adapter } }
+
+    before do
+      allow(Faraday).to receive(:new).and_return(faraday)
+    end
+
+    context 'with empty data' do
+      let(:data) { '' }
+      let(:mode) { :sync }
+
+      it { expect { subject }.to raise_error(ArgumentError) }
+    end
+
+    context 'with any data' do
+      let(:data) { 'data' }
+
+      context 'sync request' do
+        let(:mode) { :sync }
+
+        it { expect(subject.status).to eq(200) }
+        it { expect(subject.body).to eq('sync') }
+      end
+
+      context 'async request' do
+        let(:mode) { :async }
+
+        it { expect(subject.status).to eq(200) }
+        it { expect(subject.body).to eq('async') }
+      end
+    end
+  end
+end

data/spec/context_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Keepcon::Context do
+  describe '#new' do
+    subject { described_class.new(attributes) }
+
+    let(:attributes) { attributes_for(:context, mappings: { a: :b }) }
+
+    it { expect(subject.user).to eq(attributes[:user]) }
+    it { expect(subject.translate(:a)).to eq(:b) }
+  end
+
+  describe '#map & #translate' do
+    let(:attributes) { { a: :b, c: :d } }
+
+    before { subject.map(attributes) }
+
+    it { expect(subject.translate(:a)).to eq(:b) }
+    it { expect(subject.translate(:c)).to eq(:d) }
+  end
+
+  describe '#attribute_names' do
+    subject { context.attribute_names }
+
+    let(:context) { build(:context, mappings: { a: :b, c: :d }) }
+
+    it { expect(subject).to match_array([:a, :c]) }
+  end
+
+  describe '#client' do
+    subject { context.client }
+
+    let(:context) { build(:context) }
+
+    it { expect(subject.class).to eq(Keepcon::Client) }
+    it { expect(subject.user).to eq(context.user) }
+  end
+end

data/spec/entity/response_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Keepcon::Entity::Response do
+  describe '.new' do
+    subject { described_class.new(response) }
+
+    let(:response) { Faraday::Response.new.finish(status: 200, body: 'ok') }
+
+    it { expect(subject.status).to eq(200) }
+    it { expect(subject.body).to eq('ok') }
+  end
+end

data/spec/entity_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe Keepcon::Entity do
+  let(:dummy_class) do
+    Class.new do
+      define_method(:id) { 1 }
+      define_method(:a) { 1 }
+      define_method(:b) { 'b' }
+      define_method(:created_at) { Time.utc('2015-01-01') }
+    end
+  end
+
+  describe '#new' do
+    subject { described_class.new(attributes) }
+
+    let(:context) { build(:context) }
+    let(:instance) { Object.new }
+    let(:attributes) do
+      attributes_for(:entity, context: context, instance: instance)
+    end
+
+    it { expect(subject.context).to eq(attributes[:context]) }
+    it { expect(subject.instance).to eq(attributes[:instance]) }
+  end
+
+  describe '#translate' do
+    subject { entity.translate }
+
+    let(:entity) { build(:entity, context: context, instance: instance) }
+    let(:context) { build(:context, mappings: { a: :x, b: :y }) }
+    let(:instance) { dummy_class.new }
+
+    it { expect(subject).to match_array(x: 1, y: 'b') }
+    it { expect(subject.class).to eq(Hash) }
+  end
+
+  describe '#to_xml' do
+    subject { entity.to_xml }
+
+    let(:entity) { build(:entity, context: context, instance: instance) }
+    let(:instance) { dummy_class.new }
+
+    context 'when the attribute is mapped to author' do
+      let(:context) { build(:context, mappings: { a: :author }) }
+
+      it 'generates the correct xml' do
+        is_expected.to eq(<<-"END".gsub(/(\s*\n|^\s*)/, '').strip)
+          <import>
+            <contenttype>#{context.user}</contenttype>
+            <contents>
+              <content id="1">
+                <author type="author">1</author>
+              </content>
+            </contents>
+          </import>
+        END
+      end
+    end
+
+    context 'when the attribute is mapped to datetime' do
+      let(:context) { build(:context, mappings: { created_at: :datetime }) }
+
+      it 'generates the correct xml' do
+        is_expected.to eq(<<-"END".gsub(/(\s*\n|^\s*)/, '').strip)
+          <import>
+            <contenttype>#{context.user}</contenttype>
+            <contents>
+              <content id="1">
+                <datetime>1420070400000</datetime>
+              </content>
+            </contents>
+          </import>
+        END
+      end
+    end
+
+    context 'with other mappings' do
+      let(:context) { build(:context, mappings: { a: :x, b: :y }) }
+
+      it 'generates the correct xml' do
+        is_expected.to eq(<<-"END".gsub(/(\s*\n|^\s*)/, '').strip)
+          <import>
+            <contenttype>#{context.user}</contenttype>
+            <contents>
+              <content id="1">
+                <x>1</x>
+                <y><![CDATA[b]]></y>
+              </content>
+            </contents>
+          </import>
+        END
+      end
+    end
+  end
+
+  describe '#send_data' do
+    subject { entity.send_data(mode) }
+
+    let(:entity) { build(:entity, context: context, instance: instance) }
+    let(:instance) { dummy_class.new }
+    let(:context) { build(:context, mappings: { a: :x, b: :y }) }
+    let(:response) { Keepcon::Entity::Response.new(http_response) }
+    let(:http_response) { Faraday::Response.new.finish(status: 200) }
+
+    before do
+      allow(context.client).to receive(:content_request)
+        .with(entity.to_xml, mode).and_return(response)
+      subject
+    end
+
+    context 'sync request' do
+      let(:mode) { :sync }
+
+      it 'calls the #content_request with the corresponding xml' do
+        expect(context.client).to have_received(:content_request).once
+      end
+
+      it { expect(subject.status).to be 200 }
+    end
+
+    context 'async request' do
+      let(:mode) { :async }
+
+      it 'calls the #content_request with the corresponding xml' do
+        expect(context.client).to have_received(:content_request).once
+      end
+
+      it { expect(subject.status).to be 200 }
+    end
+  end
+end

data/spec/factories/contexts.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :context, class: Keepcon::Context do
+    user
+    password
+
+    initialize_with { new(attributes) }
+  end
+end

data/spec/factories/entities.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :entity, class: Keepcon::Entity do
+  end
+end

data/spec/factories/mapping.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :mapping, class: Keepcon::Mapping do
+  end
+end

data/spec/factories/sequences.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  sequence :user do |n|
+    "user_#{n}"
+  end
+
+  sequence :password do |n|
+    "password_#{n}"
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Keepcon::Integration do
+  subject { instance }
+
+  let(:dummy_class) do
+    Class.new do
+      include Keepcon::Integration
+
+      define_method(:id) { 1 }
+      define_method(:a) { 1 }
+    end
+  end
+  let(:instance) { dummy_class.new }
+  let(:added_context) { Keepcon.contexts[:user] }
+
+  before { Keepcon.add_context(:user, user: 'user', password: 'password') }
+
+  describe '.keepcon_integration' do
+    context 'when context do not exists' do
+      subject { dummy_class.keepcon_integration(:test) }
+
+      it { expect { subject }.to raise_error }
+    end
+
+    context 'when context exists' do
+      subject { dummy_class.keepcon_integration(:user, a: :b) }
+
+      before { subject }
+
+      it { expect(added_context.translate(:a)).to eq(:b) }
+      it { expect(instance.respond_to?(:send_user_to_keepcon)).to be true }
+    end
+  end
+
+  context 'with some integration defined' do
+    before { dummy_class.keepcon_integration(:user, a: :b) }
+
+    describe '#send_to_keepcon' do
+      subject { instance.send_to_keepcon(added_context, mode) }
+
+      let(:entity) do
+        Keepcon::Entity.new(context: added_context, instance: instance)
+      end
+
+      before { allow(instance).to receive(:keepcon_entity).and_return(entity) }
+
+      context 'sync request' do
+        let(:mode) { :sync }
+
+        it 'calls send_data on the entity' do
+          expect(entity).to receive(:send_data).with(:sync).once
+          subject
+        end
+      end
+
+      context 'async request' do
+        let(:mode) { :async }
+
+        it 'calls send_data on the entity' do
+          expect(entity).to receive(:send_data).with(:async).once
+          subject
+        end
+      end
+    end
+
+    describe '#keepcon_entity' do
+      subject { instance.keepcon_entity(added_context) }
+
+      it { expect(subject.context).to eq(added_context) }
+      it { expect(subject.instance).to eq(instance) }
+    end
+
+    describe '#send_context_to_keepcon' do
+      subject { instance.send_user_to_keepcon(mode) }
+
+      context 'sync request' do
+        let(:mode) { :sync }
+
+        it 'calls #send_to_keepcon with the context' do
+          expect(instance).to receive(:send_to_keepcon)
+            .with(added_context, :sync)
+          subject
+        end
+      end
+
+      context 'async request' do
+        let(:mode) { :async }
+
+        it 'calls #send_to_keepcon with the context' do
+          expect(instance).to receive(:send_to_keepcon)
+            .with(added_context, :async)
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/keepcon_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Keepcon do
+  it 'has a version number' do
+    expect(Keepcon::VERSION).not_to be nil
+  end
+
+  describe '.add_context' do
+    subject { described_class.add_context(:user_name, params) }
+
+    let(:params) { { user: 'UserName', password: 'password' } }
+    let(:added_context) { described_class.contexts[:user_name] }
+
+    before { subject }
+
+    it { expect(described_class.contexts.length).to eq(1) }
+    it { expect(added_context.user).to eq(params[:user]) }
+  end
+
+  describe '.setup' do
+    it 'passes the Keepcon module to the block' do
+      described_class.setup do |config|
+        expect(config).to eq(described_class)
+      end
+    end
+  end
+end

data/spec/mapping_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Keepcon::Mapping do
+  describe '#new' do
+    subject { described_class.new(attributes) }
+
+    let(:attributes) { attributes_for(:mapping, from: :a, to: :b) }
+
+    it { expect(subject.from).to eq(attributes[:from]) }
+    it { expect(subject.to).to eq(attributes[:to]) }
+  end
+end

data/spec/rails_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Keepcon::Rails do
+  describe '.setup!' do
+    before do
+      ActiveRecord = Class.new
+      ActiveRecord::Base = Class.new(ActiveRecord)
+    end
+
+    it 'includes Integration on ActiveModel::Model' do
+      expect(ActiveRecord::Base.include?(Keepcon::Integration)).to be false
+      described_class.setup!
+      expect(ActiveRecord::Base.include?(Keepcon::Integration)).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'keepcon'
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
+
+require_relative 'vcr_setup'
+
+RSpec.configure do |config|
+  config.after(:example) { Keepcon.contexts.clear }
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,7 @@
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  FactoryGirl.find_definitions
+end

data/spec/vcr_setup.rb

@@ -0,0 +1,7 @@
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/cassettes'
+  config.hook_into :webmock
+  config.ignore_hosts 'codeclimate.com'
+end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: keepcon
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shane O'Grady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: retryable-rb
+  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: faraday
+  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: activesupport
+  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: actionview
+  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: gyoku
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: 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: vcr
+  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: webmock
+  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: codeclimate-test-reporter
+  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:
+- shane@ogrady.ie
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keepcon.gemspec
+- lib/keepcon.rb
+- lib/keepcon/client.rb
+- lib/keepcon/config/client.yml
+- lib/keepcon/config/urls.yml
+- lib/keepcon/context.rb
+- lib/keepcon/entity.rb
+- lib/keepcon/entity/response.rb
+- lib/keepcon/integration.rb
+- lib/keepcon/mapping.rb
+- lib/keepcon/rails.rb
+- lib/keepcon/version.rb
+- spec/client_spec.rb
+- spec/context_spec.rb
+- spec/entity/response_spec.rb
+- spec/entity_spec.rb
+- spec/factories/contexts.rb
+- spec/factories/entities.rb
+- spec/factories/mapping.rb
+- spec/factories/sequences.rb
+- spec/integration_spec.rb
+- spec/keepcon_spec.rb
+- spec/mapping_spec.rb
+- spec/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_girl.rb
+- spec/vcr_setup.rb
+homepage: https://github.com/LoveMondays/keepcon
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Keepcon XML API
+test_files:
+- spec/client_spec.rb
+- spec/context_spec.rb
+- spec/entity/response_spec.rb
+- spec/entity_spec.rb
+- spec/factories/contexts.rb
+- spec/factories/entities.rb
+- spec/factories/mapping.rb
+- spec/factories/sequences.rb
+- spec/integration_spec.rb
+- spec/keepcon_spec.rb
+- spec/mapping_spec.rb
+- spec/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_girl.rb
+- spec/vcr_setup.rb