pact_broker-client 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+reports
+/.idea
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.bin
+
+# Editor files
+*.sublime*
+log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+#source 'http://rea-rubygems'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    pact_broker-client (0.0.1)
+      httparty
+      json
+      pact
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.1.0)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    daemons (1.1.9)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    fakefs (0.4.2)
+    find_a_port (1.0.1)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    method_source (0.8.2)
+    multi_xml (0.5.5)
+    pact (1.0.15)
+      awesome_print (~> 1.1.0)
+      find_a_port (~> 1.0.1)
+      json
+      rack-test (~> 0.6.2)
+      randexp (~> 0.1.7)
+      rspec (~> 2.12)
+      thin
+      thor
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    randexp (0.1.7)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-fire (1.2.0)
+      rspec (~> 2.11)
+    rspec-mocks (2.14.4)
+    slop (3.4.6)
+    thin (1.6.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.5.0)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  fakefs (~> 0.4)
+  pact_broker-client!
+  pry
+  rake (~> 10.0.3)
+  rspec-fire

data/README.md

@@ -0,0 +1,94 @@
+# PactBrokerClient
+
+Add a detailed description of the new service here before your first commit.
+
+Information here will be consumed by the Treasure Map (via the Rumour Mill). Therefore, please retain the existing formatting on this page, importantly:
+
+* The service name at the top of the page
+* The location of this description text (between service name and Custodian(s)
+* Component Custodian(s)
+
+Other headings can be deleted if they are not relevant.
+
+**NOTE: The following is provided for convenience. Please check it carefully before your first commit.**
+
+## Component Custodian(s)
+
+Enter Custodian(s) here
+
+## Development
+
+Enter any developer instructions here.
+
+### Database setup
+
+Instructions to set up the database for local testing.
+
+Then run migrations:
+
+  $ bundle exec rake db:migrate
+
+### Testing
+
+  $ bundle exec rake
+
+### Running
+
+Instructions to run the service locally.
+
+### Debugging
+
+Any specific debugging tools built in to the service (health check is assumed so don't include that).
+
+### Build
+
+**edit the below and add the correct endpoint**
+
+[Standalone (Bamboo)](http://master.cd.vpc.realestate.com.au/browse/YOUR_NEW_SERVICE_BUILD)
+
+## Deployment
+
+Deployment scripts have been generated using [biq-deploy](https://git.realestate.com.au/business-systems/biq-deploy).
+
+#### EC2 environments
+
+Before deploying to EC2 environments, you may wish to check that the build you wish to deploy has been indexed.
+
+1. Log in into the agent unix box:
+
+  $ rea-ec2-ssh agent-01.biq
+
+2. See the list of versions indexed and verify the expected version in the list:
+
+  $ yum list --showduplicates --enablerepo=rea-el6-dev pact_broker_client
+
+You can get up an running with these scripts like so (from within the pact_broker_client project on your local machine):
+
+  $ cd deploy
+  $ bundle
+  $ bundle exec bin/pact-broker-client-deploy-ec2 --help
+
+When deploying to an EC2 environment for the first time, you must create a node for the app:
+
+  $ bundle exec bin/pact-broker-client-deploy-ec2 -t create -s $YOUR_SUBDOMAIN -p dev
+
+The first time the service is deployed, a database must be created. After adding the [required config values](https://git.realestate.com.au/business-systems/pact_broker_client/blob/master/lib/environment_variables.rb) to the
+environment's config-svc, you can run the db provision task:
+
+  $ bundle exec bin/pact-broker-client-deploy-ec2 -t db_provision -s $YOUR_SUBDOMAIN
+
+Then you are free to migrate the db from then on:
+
+  $ bundle exec bin/pact-broker-client-deploy-ec2 -t db_migrate -s $YOUR_SUBDOMAIN
+
+To deploy to a test environment (eg biq-qa1):
+
+        $ bundle exec bin/pact-broker-client-deploy-ec2 -t deploy -s biq-qa1 -p dev -y
+
+#### Production
+
+Refer to the [production deployment readme](https://git.realestate.com.au/business-systems/pact_broker_client/blob/master/README-ProdDeploy.md).
+
+### Architecture
+
+Any important architectural information.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_helper'
+module Bundler
+  class GemHelper
+    def install
+      desc "Build #{name}-#{version}.gem into the pkg directory"
+      task 'build' do
+        build_gem
+      end
+
+      desc "Build and install #{name}-#{version}.gem into system gems"
+      task 'install' do
+        install_gem
+      end
+
+      GemHelper.instance = self
+    end
+  end
+end
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+#require 'geminabox-client'
+
+Dir.glob('lib/tasks/**/*.rake').each { |task| load task }
+Dir.glob('tasks/**/*.rake').each { |task| load task }
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]
+
+# desc "Release to REA gems host"
+# task :publish => :build do
+#   gem_file = "pkg/pact-broker-client#{PactBroker::Client::VERSION}.gem"
+#   Geminabox::Client.new('http://rea-rubygems').upload(gem_file)
+# end

data/ci.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+RUBY_VERSION=1.9.3-p194
+
+eval $( curl http://dist/rea/toolchain/ruby-env-rbenv-polite | bash -s $RUBY_VERSION )
+rbenv local $RUBY_VERSION
+bundle config --delete path
+bundle config --delete without
+bundle install && bundle exec rake "$@"

data/lib/pact_broker/client/base_client.rb

@@ -0,0 +1,76 @@
+require 'erb'
+require 'httparty'
+
+module PactBroker
+  module Client
+
+    module UrlHelpers
+      def encode_param param
+        ERB::Util.url_encode param
+      end
+    end
+
+    module StringToSymbol
+
+      #Only works for one level, not recursive!
+      def string_keys_to_symbols hash
+        hash.keys.each_with_object({}) do | key, new_hash |
+          new_hash[key.to_sym] = hash[key]
+        end
+      end
+
+    end
+
+    class BaseClient
+      include UrlHelpers
+      include HTTParty
+      include StringToSymbol
+
+      attr_reader :base_url
+
+      def initialize options
+        @base_url = options[:base_url]
+        self.class.base_uri base_url
+      end
+
+      def default_request_headers
+        {'Accept' => 'application/json'}
+      end
+
+      def default_get_headers
+        default_request_headers
+      end
+
+      def default_patch_headers
+        default_request_headers.merge('Content-Type' => 'application/json+patch')
+      end
+
+      def default_put_headers
+        default_request_headers.merge('Content-Type' => 'application/json')
+      end
+
+      def handle_response response
+        if response.success?
+          yield
+        elsif response.code == 404
+          nil
+        else
+          raise response.body
+        end
+      end
+
+      def patch url, options
+        self.class.patch(url, options.merge(body: options[:body].to_json))
+      end
+
+      def put url, *args
+        self.class.put(url, *args)
+      end
+
+      def get url, *args
+        self.class.get(url, *args)
+      end
+
+    end
+  end
+end

data/lib/pact_broker/client/pact_broker_client.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/pacticipants'
+require 'pact_broker/client/versions'
+require 'pact_broker/client/pacts'
+
+
+module PactBroker
+
+
+  module Client
+
+    DEFAULT_PACT_BROKER_BASE_URL = 'http://pact-broker'
+
+    class PactBrokerClient
+
+      DEFAULT_OPTIONS = {base_url: DEFAULT_PACT_BROKER_BASE_URL}
+
+      attr_reader :base_url
+
+      def initialize options = {}
+        merged_options = DEFAULT_OPTIONS.merge(options)
+        @base_url = merged_options[:base_url]
+      end
+
+      def pacticipants
+        PactBroker::Client::Pacticipants.new base_url: base_url
+      end
+
+    end
+  end
+
+end

data/lib/pact_broker/client/pacticipants.rb

@@ -0,0 +1,34 @@
+require 'pact_broker/client/base_client'
+
+module PactBroker
+  module Client
+    class Pacticipants < BaseClient
+
+      def versions
+        Versions.new base_url: base_url
+      end
+
+      def update options
+        body = options.select{ | key, v | [:repository_url].include?(key)}
+        response = patch(pacticipant_base_url(options), body: body, headers: default_patch_headers)
+        handle_response(response) do
+          true
+        end
+      end
+
+      def repository_url options
+        response = get("#{pacticipant_base_url(options)}/repository_url", headers: default_get_headers.merge('Accept' => 'text/plain'))
+        handle_response(response) do
+          response.body
+        end
+      end
+
+      private
+
+      def pacticipant_base_url options
+        "/pacticipant/#{encode_param(options[:pacticipant])}"
+      end
+
+    end
+  end
+end

data/lib/pact_broker/client/pacts.rb

@@ -0,0 +1,45 @@
+require 'pact/consumer_contract'
+require_relative 'base_client'
+
+
+module PactBroker
+  module Client
+    class Pacts  < BaseClient
+
+      def publish options
+        consumer_version = options[:consumer_version]
+        pact_string = options[:pact]
+        consumer_contract = ::Pact::ConsumerContract.from_json pact_string
+        url = save_consumer_contract_url consumer_contract, consumer_version
+        response = self.class.put(url, body: pact_string, headers: default_put_headers)
+        handle_response(response) do
+          true
+        end
+      end
+
+      def last options
+        url = find_last_consumer_contract_url options
+        query = options[:tag] ? {tag: options[:tag]} : {}
+        response = self.class.get(url, headers: default_get_headers, query: query)
+        handle_response(response) do
+          response.body
+        end
+      end
+
+      private
+
+      def find_last_consumer_contract_url options
+        consumer_name = encode_param(options[:consumer])
+        provider_name = encode_param(options[:provider])
+        "/pacticipant/#{consumer_name}/versions/last/pacts/#{provider_name}"
+      end
+
+      def save_consumer_contract_url consumer_contract, consumer_version
+        consumer_name = encode_param(consumer_contract.consumer.name)
+        provider_name = encode_param(consumer_contract.provider.name)
+        version = encode_param(consumer_version)
+        "/pacticipant/#{consumer_name}/versions/#{version}/pacts/#{provider_name}"
+      end
+    end
+  end
+end

data/lib/pact_broker/client/publish_pacts.rb

@@ -0,0 +1,44 @@
+require 'pact_broker/client'
+
+module PactBroker
+  module Client
+    class PublishPacts
+
+      def initialize pact_broker_base_url, pact_files, consumer_version
+        @pact_broker_base_url = pact_broker_base_url
+        @pact_files = pact_files
+        @consumer_version = consumer_version
+      end
+
+      def call
+        validate
+        pact_files.collect{ | pact_file | publish_pact pact_file }.all?
+      end
+
+      private
+
+      attr_reader :pact_broker_base_url, :pact_files, :consumer_version
+
+      def pact_broker_client
+        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url)
+      end
+
+      def publish_pact pact_file
+        begin
+          pact_broker_client.pacticipants.versions.pacts.publish(pact_json: File.read(pact_file), consumer_version: consumer_version)
+          true
+        rescue => e
+          $stderr.puts "Failed to publish pact: #{pact_file} due to error: #{e.to_s}\n#{e.backtrace.join("\n")}"
+          false
+        end
+      end
+
+      def validate
+        raise "Please specify the consumer_version" unless (consumer_version && consumer_version.to_s.strip.size > 0)
+        raise "Please specify the pact_broker_base_url" unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)
+        raise "No pact files found" unless (pact_files && pact_files.any?)
+      end
+
+    end
+  end
+end

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -0,0 +1,46 @@
+require 'rake/tasklib'
+
+=begin
+require pact_broker/client/tasks
+
+PactBroker::Client::PublicationTask.new do | task |
+  require 'consumer/version'
+  task.pact_broker_base_url = 'http://pact-broker'
+  task.consumer_version = Consumer::VERSION
+end
+
+=end
+
+module PactBroker
+  module Client
+    class PublicationTask < ::Rake::TaskLib
+
+      attr_accessor :pattern, :pact_broker_base_url, :consumer_version
+
+      def initialize name = nil
+        @name = name
+        @pattern = 'spec/pacts/*.json'
+        @pact_broker_base_url = 'http://pact-broker'
+        yield self
+        rake_task
+      end
+
+      private
+
+      def rake_task
+        namespace :pact do
+          task task_name do
+            require 'pact_broker/client/publish_pacts'
+            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[@pattern], consumer_version).call
+            raise "One or more pacts failed to be published" unless success
+          end
+        end
+      end
+
+      def task_name
+        @name ? "publish:#{@name}" : "publish"
+      end
+
+    end
+  end
+end

data/lib/pact_broker/client/tasks.rb

@@ -0,0 +1 @@
+require 'pact_broker/client/tasks/publication_task'

data/lib/pact_broker/client/version.rb

@@ -0,0 +1,5 @@
+module PactBroker
+  module Client
+    VERSION = '0.0.1'
+  end
+end

data/lib/pact_broker/client/versions.rb

@@ -0,0 +1,38 @@
+require_relative 'base_client'
+
+module PactBroker
+  module Client
+    class Versions < BaseClient
+
+
+      def last options
+        query = options[:tag] ? {tag: options[:tag]} : {}
+        response = self.class.get("#{version_base_url(options)}/last", query: query, headers: default_get_headers)
+
+        handle_response(response) do
+          string_keys_to_symbols(response.to_hash)
+        end
+      end
+
+      def update options
+        body = options.select{ | key, v | [:repository_ref, :repository_url, :tags].include?(key)}
+        body[:tags] ||= []
+        (body[:tags] << options[:tag]) if options[:tag]
+        response = patch("#{version_base_url(options)}/#{options[:version]}", body: body, headers: default_patch_headers)
+        handle_response(response) do
+          true
+        end
+      end
+
+      def pacts
+        Pacts.new base_url: base_url
+      end
+
+      private
+      def version_base_url options
+        pacticipant = encode_param(options[:pacticipant])
+        "/pacticipant/#{pacticipant}/versions"
+      end
+    end
+  end
+end

data/lib/pact_broker/client.rb

@@ -0,0 +1,2 @@
+require 'pact_broker/client/version'
+require 'pact_broker/client/pact_broker_client'

data/lib/pact_broker_client.rb

@@ -0,0 +1,2 @@
+require 'pact_broker_client/version'
+require 'pact_broker_client/client'

data/pact-broker-client.gemspec

@@ -0,0 +1,32 @@
+
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pact_broker/client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pact_broker-client"
+  gem.version       = PactBroker::Client::VERSION
+  gem.authors       = ["Bethany Skurrie"]
+  gem.email         = ["bskurrie@dius.com.au"]
+  gem.description   = %q{Publishes pacts to, and retrieves pacts from, the pact broker server.}
+  gem.summary       = %q{See description}
+  gem.homepage      = "https://github.com/bethesque/pact_broker-client.git"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'pact'
+  gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'json' #Not locking down a version because buncher gem requires 1.6, while other projects use 1.7.
+
+  #gem.add_development_dependency 'geminabox-client'
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'fakefs', '~> 0.4'
+  gem.add_development_dependency 'rspec-fire'
+  gem.add_development_dependency 'debugger'
+end

data/spec/lib/pact_broker/client/pact_broker_client_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+require 'pact_broker/client'
+
+module PactBroker::Client
+  describe PactBrokerClient do
+
+    describe 'initialize' do
+      subject { PactBrokerClient.new }
+      it 'sets the base_uri to http://pact-broker by default' do
+        expect(subject.base_url).to eq('http://pact-broker')
+      end
+
+      it 'allows configuration of the base_uri' do
+        expect(PactBrokerClient.new(base_url: 'https://blah').base_url).to eq('https://blah')
+      end
+    end
+  end
+
+end