openrtb-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a014bcbe57f7cf7df9bd4902e94ec8ca279200e7
+  data.tar.gz: fbf9529ddaaabcda7a986c39ce76db2d90c3103a
+SHA512:
+  metadata.gz: b7cc2a4a1ad904fc6e77d7b1d00dd025e477aaee3facc1ca53401e81fdb0c149c7a7cd80f8369e0b20e2c626fac91606a5848372ae7b54093310e862a5f21d70
+  data.tar.gz: 9e76be854c51f896d9bc69714174ba9765b1f5292a5be1833e3c2d01f0591fd4e0987bd6539cc527f01469b2bc690b51d21f46faaa6e87e655ef06aa75ae13b6

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+bin/
+coverage/
+doc/
+pkg/

data/.travis.yml

@@ -0,0 +1,21 @@
+env:
+  global:
+    - JRUBY_OPTS="$JRUBY_OPTS --debug"
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+  - jruby-head
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-19mode
+  fast_finish: true
+notifications:
+  email:
+    - dev@realmediadigital.com

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Realmedia Latin America
+
+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 @@
+# OpenRTB Ruby Client

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.verbose = true
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :default => :test

data/lib/openrtb.rb

@@ -0,0 +1,6 @@
+require 'openrtb/version'
+require 'openrtb/error'
+require 'openrtb/null_object'
+require 'openrtb/request'
+require 'openrtb/response'
+require 'openrtb/client'

data/lib/openrtb/client.rb

@@ -0,0 +1,114 @@
+require 'addressable/uri'
+require 'multi_json'
+require 'typhoeus'
+
+Typhoeus::Config.memoize = false
+Typhoeus::Config.verbose = false
+
+module OpenRTB
+  class Client
+    attr_accessor :proxy
+    attr_writer :logger, :max_concurrency, :user_agent, :version
+
+    class Queue
+      include NullObject::Conversions
+
+      def initialize(client, hydra)
+        @client = client
+        @hydra  = hydra
+      end
+
+      def responses
+        @responses ||= []
+      end
+
+      def post(endpoint, body = {})
+        req = request(endpoint, :post, OpenRTB::Request.new(body))
+        req.on_complete { |res| responses << res }
+
+        @hydra.queue req
+      end
+
+    private
+
+      def request(endpoint, method, body)
+        uri = Addressable::URI.parse(Just(endpoint))
+        opt = {body: MultiJson.dump(body), method: method}
+        opt.merge!(userpwd: uri.userinfo) if uri.userinfo
+
+        Typhoeus::Request.new(uri.omit(:userinfo).to_s, options(opt))
+      end
+
+      def options(hash = {})
+        hash[:proxy] = @client.proxy
+        hash[:headers] ||= {}
+        hash[:headers]['Content-Type'] = 'application/json'
+        hash[:headers]['User-Agent']   = @client.user_agent
+        hash[:headers]['x-openrtb-version'] = @client.version
+        hash[:timeout] = 1
+        hash[:connecttimeout]  = 1
+        hash[:followlocation]  = false
+        hash[:accept_encoding] = 'gzip'
+        hash[:ssl_verifypeer]  = false
+        hash[:ssl_verifyhost]  = 0
+        hash
+      end
+    end
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def logger
+      @logger ||= OpenRTB::NullObject.new
+    end
+
+    def max_concurrency
+      @max_concurrency ||= 2
+    end
+
+    def user_agent
+      @user_agent ||= "OpenRTB Ruby Client #{OpenRTB::VERSION}"
+    end
+
+    def version
+      @version ||= '2.1'
+    end
+
+    def execute(&block)
+      hydra = Typhoeus::Hydra.new(max_concurrency: max_concurrency)
+      queue = Queue.new(self, hydra)
+      block.call(queue)
+      hydra.run
+
+      handle_responses(queue.responses)
+    end
+
+  private
+
+    def handle_responses(responses)
+      result = []
+      responses.each do |res|
+        begin
+          logger.debug({
+            effective_url: res.effective_url,
+            primary_ip: res.primary_ip,
+            response_code: res.response_code,
+            response_headers: res.response_headers,
+            namelookup_time: res.namelookup_time,
+            connect_time: res.connect_time,
+            app_connect_time: res.app_connect_time,
+            pretransfer_time: res.pretransfer_time,
+            start_transfer_time: res.start_transfer_time,
+            total_time: res.total_time,
+            body: res.body})
+
+          result.push OpenRTB::Response.new(MultiJson.load(res.body)) if res.success?
+        rescue MultiJson::ParseError => e
+          logger.error(e.cause)
+        end
+      end
+      result
+    end
+  end
+end

data/lib/openrtb/error.rb

@@ -0,0 +1,5 @@
+require 'nesty'
+
+module OpenRTB
+  Error = Class.new(Nesty::NestedStandardError)
+end

data/lib/openrtb/null_object.rb

@@ -0,0 +1,14 @@
+require 'naught'
+
+module OpenRTB
+  NullObject = Naught.build do |config|
+    config.black_hole
+    config.define_explicit_conversions
+    config.define_implicit_conversions
+    config.predicates_return false
+
+    def nil?
+      true
+    end
+  end
+end

data/lib/openrtb/request.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+
+module OpenRTB
+  class Request < Hashie::Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::IndifferentAccess
+  end
+end

data/lib/openrtb/response.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+
+module OpenRTB
+  class Response < Hashie::Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::IndifferentAccess
+  end
+end

data/lib/openrtb/version.rb

@@ -0,0 +1,3 @@
+module OpenRTB
+  VERSION = '1.0.0'
+end

data/openrtb-client.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'openrtb/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'openrtb-client'
+  s.version     = OpenRTB::VERSION
+  s.summary     = %Q{OpenRTB Ruby Client}
+  s.description = %Q{OpenRTB Ruby Client}
+  s.author      = 'Realmedia Latin America'
+  s.email       = 'dev@realmediadigital.com'
+  s.homepage    = 'http://github.com/realmedia/openrtb-ruby-client'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.3'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split('\n')
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'addressable', '~> 2.3.6'
+  s.add_dependency 'hashie',      '~> 3.2.0'
+  s.add_dependency 'multi_json',  '~> 1.10.1'
+  s.add_dependency 'naught',      '~> 1.0.0'
+  s.add_dependency 'nesty',       '~> 1.0.2'
+  s.add_dependency 'typhoeus',    '~> 0.6.9'
+
+  s.add_development_dependency 'rake',     '~> 10.3'
+  s.add_development_dependency 'minitest', '~> 5.2'
+  s.add_development_dependency 'webmock',  '~> 1.18'
+end

data/test/fixtures/response.json

@@ -0,0 +1,25 @@
+{
+    "id": "BID-4-ZIMP-4b309eae-504a-4252-a8a8-4c8ceee9791a",
+    "seatbid": [
+        {
+            "bid": [
+                {
+                    "id": "32a69c6ba388f110487f9d1e63f77b22d86e916b",
+                    "impid": "32a69c6ba388f110487f9d1e63f77b22d86e916b",
+                    "price": 0.065445,
+                    "adid": "529833ce55314b19e8796116",
+                    "nurl": "http://ads.com/win/529833ce55314b19e8796116?won=${AUCTION_PRICE}",
+                    "adm": "<iframe src=\"http://ads.com/render/529833ce55314b19e8796116\" width=\"300\" height=\"250\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\" topmargin=\"0\" leftmargin=\"0\"></iframe>",
+                    "adomain": [
+                        "ads.com"
+                    ],
+                    "cid": "529833ce55314b19e8796116",
+                    "crid": "529833ce55314b19e8796116_1385706446",
+                    "attr": []
+                }
+            ],
+            "seat": "772"
+        }
+    ],
+    "cur": "USD"
+}

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'openrtb'

data/test/test_client.rb

@@ -0,0 +1,58 @@
+require 'helper'
+require 'webmock'
+WebMock.disable_net_connect!
+
+describe OpenRTB::Client do
+  include WebMock::API
+
+  let(:endpoint) { 'http://api.example.org/exchange.json' }
+  let(:request) { {
+    id: 1
+    } }
+  let(:headers) { {
+    'User-Agent'        => @client.user_agent,
+    'Content-Type'      => 'application/json',
+    'X-Openrtb-Version' => @client.version
+    } }
+
+  before do
+    @client = OpenRTB::Client.new
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  def fixture(file)
+    File.new(File.join(File.expand_path('../fixtures', __FILE__), file))
+  end
+
+  describe '#execute' do
+    it 'encodes the body and makes the request with the correct headers' do
+      stub_request(:post, endpoint).to_return(status: 200, body: fixture('response.json'))
+
+      responses = @client.execute do |q|
+        q.post(endpoint, request)
+      end
+
+      assert_requested(:post, endpoint, times: 1) do |req|
+        assert_equal MultiJson.dump(request), req.body
+        assert_equal headers, req.headers
+      end
+
+      assert_equal responses.size, 1
+      responses.each { |res| assert_instance_of OpenRTB::Response, res }
+    end
+
+    it 'makes multiple requests' do
+      stub_request(:post, endpoint).to_return(status: 200, body: fixture('response.json'))
+
+      responses = @client.execute do |q|
+        q.post(endpoint, request)
+        q.post(endpoint, request)
+      end
+
+      assert_requested(:post, endpoint, times: 2)
+    end
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: openrtb-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Realmedia Latin America
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: naught
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: nesty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: OpenRTB Ruby Client
+email: dev@realmediadigital.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/openrtb.rb
+- lib/openrtb/client.rb
+- lib/openrtb/error.rb
+- lib/openrtb/null_object.rb
+- lib/openrtb/request.rb
+- lib/openrtb/response.rb
+- lib/openrtb/version.rb
+- openrtb-client.gemspec
+- test/fixtures/response.json
+- test/helper.rb
+- test/test_client.rb
+homepage: http://github.com/realmedia/openrtb-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: OpenRTB Ruby Client
+test_files: []