display_words 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7-p330@display_words

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    display_words (0.0.1)
+      httparty (~> 0.7.7)
+      json_pure (~> 1.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.5)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    httparty (0.7.7)
+      crack (= 0.1.8)
+    json_pure (1.5.1)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  display_words!
+  rake (~> 0.8)
+  rspec (~> 2.5)
+  webmock (~> 1.6)

data/README

@@ -0,0 +1,5 @@
+Example Use:
+
+client = DisplayWords.client(:username => 'someuser', :password => 'somepass', :domain => 'http://somedomain.com')
+inventory_sources = client.inventory_sources
+inventory_source  = client.inventory_source(1)

data/display_words.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/display_words/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('webmock', '~> 1.6')
+  s.add_runtime_dependency('json_pure', '~> 1.5')
+  s.add_runtime_dependency('httparty', '~> 0.7.7')
+  s.authors = ["Will Watson"]
+  s.description = %q{A Ruby wrapper for the DisplayWords API}
+  s.email = ['will@ackmanndickenson.com']
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/ackmann-dickenson/display_words'
+  s.name = 'display_words'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{Ruby wrapper for the DisplayWords API}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = DisplayWords::VERSION.dup
+end

data/lib/display_words.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'httparty'
+
+require File.expand_path('../display_words/configuration', __FILE__)#can this not use expand_path?
+require File.expand_path('../display_words/api', __FILE__)
+require File.expand_path('../display_words/client', __FILE__)
+
+module DisplayWords
+  extend Configuration
+
+  def self.client(options = {})
+    DisplayWords::Client.new(options)
+  end
+
+  # Delegate to DisplayWords::Client
+#  def self.method_missing(method, *args, &block)
+#    return super unless client.respond_to?(method)
+#    client.send(method, *args, &block)
+#  end
+#
+#  def self.respond_to?(method, include_private = false)
+#    client.respond_to?(method, include_private) || super(method, include_private)
+#  end
+end

data/lib/display_words/api.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../request', __FILE__)
+
+module DisplayWords
+  class API
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    include DisplayWords::Request
+
+    def initialize(options={})
+      self.class.base_uri options[:domain]
+
+      options = DisplayWords.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+  end
+end

data/lib/display_words/authentication.rb

@@ -0,0 +1,42 @@
+module DisplayWords
+  module Request
+    module Authentication
+      ENDPOINT = '/auth'
+
+      attr_accessor :token, :token_expire
+
+      def authenticate(username, password)
+        options = authentication_options(username, password)
+
+        response = post(ENDPOINT, options)
+
+        @token_expire = Time.now + (2 * 60 * 60) #Token expires two hours from when it was given
+        @token        = response['token']
+      end
+
+      def expired_token?
+        token_expire <= Time.now
+      end
+
+      def authentication_needed?
+        !token || expired_token?
+      end
+
+      def authentication_options(username, password)
+        credentials = {
+          :auth => {
+            :username => username,
+            :password => password
+          }
+        }
+
+        {
+          :body => credentials.to_json,
+          :headers => {
+            "content_type" => "json"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/display_words/client.rb

@@ -0,0 +1,9 @@
+module DisplayWords
+  class Client < API
+    DEFAULT_RESULT_LIMIT = 100
+
+    require File.expand_path('../client/inventory_source', __FILE__)
+
+    include DisplayWords::Client::InventorySource
+  end
+end

data/lib/display_words/client/inventory_source.rb

@@ -0,0 +1,15 @@
+module DisplayWords
+  class Client
+    module InventorySource
+      def inventory_source(id)
+        response = get("/inventory-source/?id=#{id}")
+        response['inventory-source']
+      end
+
+      def inventory_sources(start = 0, num = Client::DEFAULT_RESULT_LIMIT)
+        response = get("/inventory-source?start_element=#{start}&num_elements=#{num}")
+        response['inventory-sources']
+      end
+    end
+  end
+end

data/lib/display_words/configuration.rb

@@ -0,0 +1,36 @@
+module DisplayWords
+  module Configuration
+    VALID_OPTIONS_KEYS = [:username, :password, :domain, :format]
+    VALID_FORMATS      = [:json]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    DEFAULT_DOMAIN = 'http://hb.sand-08.adnxs.net/'
+    DEFAULT_FORMAT = 'json'
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+      self
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k) }
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.domain = DEFAULT_DOMAIN
+      self.format = DEFAULT_FORMAT
+      self
+    end
+  end
+end

data/lib/display_words/request.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../authentication', __FILE__)
+
+module DisplayWords
+  module Request
+    def self.included(base)
+      base.class_eval do
+        include HTTParty
+        include Authentication
+      end
+    end
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      authenticate(@username, @password) if authentication_needed? && path != Authentication::ENDPOINT
+
+      options[:headers] ||= {}
+      options[:headers]['authorization'] = token if token
+      response = case method
+        when :post
+          self.class.post(
+            path,
+            options
+          )
+        when :get
+          self.class.get(
+            path,
+            options
+          )
+      end
+
+      response['response']
+    end
+  end
+end

data/lib/display_words/version.rb

@@ -0,0 +1,4 @@
+module DisplayWords
+  # The version of the gem
+  VERSION = '0.0.1'.freeze unless defined?(::DisplayWords::VERSION)
+end

data/spec/display_words/api_spec.rb

@@ -0,0 +1,66 @@
+require 'spec/spec_helper'
+
+describe DisplayWords::API do
+  before do
+    @keys = DisplayWords::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+    before do
+      DisplayWords.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      DisplayWords.reset
+    end
+
+    it "should inherit module configuration" do
+      api = DisplayWords::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :username => 'U',
+          :password => 'P',
+          :domain   => 'http://www.d.com',
+          :format   => 'json'
+        }
+      end
+
+      context "during initialization"
+
+        it "should override module configuration" do
+          api = DisplayWords::API.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = DisplayWords::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+        it "should have set the base_uri" do
+
+        end
+      end
+    end
+  end
+end

data/spec/display_words/client/inventory_source_spec.rb

@@ -0,0 +1,93 @@
+require 'spec/spec_helper'
+
+describe DisplayWords::Client do
+  DisplayWords::Configuration::VALID_FORMATS.each do |format|
+    context ".new" do
+      before do
+        @client = DisplayWords::Client.new(:username => 'u', :password => 'p', :domain => "http://hb.sand-08.adnxs.net/")
+        @client.stub(:authentication_needed?).and_return(false)
+        @client.stub(:token).and_return("abcdefg")
+      end
+
+      describe ".inventory_sources" do
+        before do
+          @client.stub(:get).
+            with("/inventory-source?start_element=0&num_elements=100").and_return(fixture_json("inventory_sources.json")['response'])
+        end
+
+        it "should get the correct resource" do
+          @client.should_receive(:get).with("/inventory-source?start_element=0&num_elements=100")
+          @client.inventory_sources
+        end
+
+        it "should return inventory sources" do
+          inventory_sources = @client.inventory_sources
+          inventory_sources.should be_an Array
+          inventory_sources.first['name'].should == "Premium Nature 1"
+        end
+      end
+
+#      describe ".direct_messages_sent" do
+#
+#        before do
+#          stub_get("direct_messages/sent.#{format}").
+#            to_return(:body => fixture("direct_messages.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+#        end
+#
+#        it "should get the correct resource" do
+#          @client.direct_messages_sent
+#          a_get("direct_messages/sent.#{format}").
+#            should have_been_made
+#        end
+#
+#        it "should return the 20 most recent direct messages sent by the authenticating user" do
+#          direct_messages = @client.direct_messages_sent
+#          direct_messages.should be_an Array
+#          direct_messages.first.sender.name.should == "Erik Michaels-Ober"
+#        end
+#
+#      end
+#
+#      describe ".direct_message_create" do
+#
+#        before do
+#          stub_post("direct_messages/new.#{format}").
+#            with(:body => {:screen_name => "pengwynn", :text => "Creating a fixture for the DisplayWords gem"}).
+#            to_return(:body => fixture("direct_message.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+#        end
+#
+#        it "should get the correct resource" do
+#          @client.direct_message_create("pengwynn", "Creating a fixture for the DisplayWords gem")
+#          a_post("direct_messages/new.#{format}").
+#            with(:body => {:screen_name => "pengwynn", :text => "Creating a fixture for the DisplayWords gem"}).
+#            should have_been_made
+#        end
+#
+#        it "should return the sent message" do
+#          direct_message = @client.direct_message_create("pengwynn", "Creating a fixture for the DisplayWords gem")
+#          direct_message.text.should == "Creating a fixture for the DisplayWords gem"
+#        end
+#
+#      end
+#
+#      describe ".direct_message_destroy" do
+#
+#        before do
+#          stub_delete("direct_messages/destroy/1825785544.#{format}").
+#            to_return(:body => fixture("direct_message.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+#        end
+#
+#        it "should get the correct resource" do
+#          @client.direct_message_destroy(1825785544)
+#          a_delete("direct_messages/destroy/1825785544.#{format}").
+#            should have_been_made
+#        end
+#
+#        it "should return the deleted message" do
+#          direct_message = @client.direct_message_destroy(1825785544)
+#          direct_message.text.should == "Creating a fixture for the DisplayWords gem"
+#        end
+#      end
+    end
+  end
+end

data/spec/display_words_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe DisplayWords do
+  after do
+    DisplayWords.reset
+  end
+
+  describe ".client" do
+    it "should be a DisplayWords::Client" do
+      DisplayWords.client.should be_a DisplayWords::Client
+    end
+  end
+
+  describe ".domain" do
+    it "should return the default domain" do
+      DisplayWords.domain.should == DisplayWords::Configuration::DEFAULT_DOMAIN
+    end
+  end
+
+  describe ".domain=" do
+    it "should set the endpoint" do
+      DisplayWords.domain = 'https://api.displaywords.com/'
+      DisplayWords.domain.should == 'https://api.displaywords.com/'
+    end
+  end
+end

data/spec/fixtures/auth.json

@@ -0,0 +1,6 @@
+{
+  "response": {
+    "status": "OK",
+    "token": "abcdefghijklmnop"
+  }
+}

data/spec/fixtures/inventory_source.json

@@ -0,0 +1,29 @@
+{
+  "response": {
+    "status": "OK",
+    "inventory-source": {
+      "id": 14,
+      "name": "MyYearbook",
+      "description": "",
+      "aggregator": "MyYearbook",
+      "url": "myyearbook.com",
+      "integration_type": "premium_first",
+      "monthly_volume": 464493100,
+      "monthly_uniques": 5638924,
+      "daily_volume": 1123983,
+      "daily_uniques": 659323,
+      "member_id": null,
+      "class": "class_3",
+      "status": "reviewed",
+      "created_on": "2009-11-02 05:00:00",
+      "discrepancy_pct": null,
+      "curated_type": "appnexus",
+      "inventory_exposure": "public",
+      "last_modified": "2010-10-15 00:11:43",
+      "ecp": 0.91957,
+      "age_coverage": 0.994941,
+      "gender_coverage": 0.994845,
+      "expose_domains": true
+    }
+  }
+}

data/spec/fixtures/inventory_sources.json

@@ -0,0 +1,73 @@
+{
+   "response":{
+      "status":"OK",
+      "inventory-sources":[
+         {
+            "id":2,
+            "name":"Premium Nature 1",
+            "description":"",
+            "aggregator":"AdMeld",
+            "url":"",
+            "integration_type":"remnant_first",
+            "monthly_volume":0,
+            "monthly_uniques":0,
+            "daily_volume":0,
+            "daily_uniques":0,
+            "member_id":null,
+            "class":"class_3",
+            "status":"pending",
+            "created_on":"2009-11-02 05:00:00",
+            "discrepancy_pct":5,
+            "curated_type":"appnexus",
+            "inventory_exposure":"public",
+            "last_modified":"2010-04-14 14:35:56",
+            "ecp":null
+         },
+         {
+            "id":3,
+            "name":"Premium Human Behavior 1",
+            "description":"",
+            "aggregator":"AdMeld",
+            "url":"",
+            "integration_type":"remnant_first",
+            "monthly_volume":0,
+            "monthly_uniques":0,
+            "daily_volume":0,
+            "daily_uniques":0,
+            "member_id":null,
+            "class":"class_3",
+            "status":"pending",
+            "created_on":"2009-11-02 05:00:00",
+            "discrepancy_pct":5,
+            "curated_type":"appnexus",
+            "inventory_exposure":"public",
+            "last_modified":"2010-04-14 14:35:56",
+            "ecp":null
+         },
+         {
+            "id":4,
+            "name":"Premium Health 1",
+            "description":"",
+            "aggregator":"AdMeld",
+            "url":"",
+            "integration_type":"remnant_first",
+            "monthly_volume":0,
+            "monthly_uniques":0,
+            "daily_volume":0,
+            "daily_uniques":0,
+            "member_id":null,
+            "class":"class_3",
+            "status":"pending",
+            "created_on":"2009-11-02 05:00:00",
+            "discrepancy_pct":5,
+            "curated_type":"appnexus",
+            "inventory_exposure":"public",
+            "last_modified":"2010-04-14 14:35:56",
+            "ecp":null
+         }
+      ],
+      "count":769,
+      "start_element":1,
+      "num_elments":3
+   }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../../lib/display_words.rb', __FILE__)
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+def a_delete(path)
+  a_request(:delete, DisplayWords.domain + path)
+end
+
+def a_get(path)
+  a_request(:get, DisplayWords.domain + path)
+end
+
+def a_post(path)
+  a_request(:post, DisplayWords.domain + path)
+end
+
+def a_put(path)
+  a_request(:put, DisplayWords.domain + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, DisplayWords.domain + path)
+end
+
+def stub_get(path)
+  stub_request(:get, DisplayWords.domain + path)
+end
+
+def stub_post(path)
+
+  stub_request(:post, DisplayWords.domain + path)
+end
+
+def stub_put(path)
+  stub_request(:put, DisplayWords.domain + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def fixture_json(file)
+  s = File.new(fixture_path + '/' + file).each_line.inject("") {|sum, line| sum += line }
+  JSON s
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: display_words
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Will Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id005
+description: A Ruby wrapper for the DisplayWords API
+email: 
+- will@ackmanndickenson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README
+- display_words.gemspec
+- lib/display_words.rb
+- lib/display_words/api.rb
+- lib/display_words/authentication.rb
+- lib/display_words/client.rb
+- lib/display_words/client/inventory_source.rb
+- lib/display_words/configuration.rb
+- lib/display_words/request.rb
+- lib/display_words/version.rb
+- spec/display_words/api_spec.rb
+- spec/display_words/client/inventory_source_spec.rb
+- spec/display_words_spec.rb
+- spec/fixtures/auth.json
+- spec/fixtures/inventory_source.json
+- spec/fixtures/inventory_sources.json
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/ackmann-dickenson/display_words
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: display_words
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the DisplayWords API
+test_files: 
+- spec/display_words/api_spec.rb
+- spec/display_words/client/inventory_source_spec.rb
+- spec/display_words_spec.rb
+- spec/fixtures/auth.json
+- spec/fixtures/inventory_source.json
+- spec/fixtures/inventory_sources.json
+- spec/spec_helper.rb