pomade 0.1.1 → 0.1.2

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jake Bellacera
+
+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/Rakefile

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

data/lib/pomade.rb

@@ -1,129 +1,2 @@
-require 'ntlm/http'
-require 'nokogiri'
-
-class Pomade
-  def initialize(subdomain, username, password, client_id, opts = {})
-    @subdomain = subdomain
-    @username = username
-    @password = password
-    @client_id = client_id
-
-    # Other options
-    @options = {}
-    @options[:domain] = opts[:domain] || 'timessquare2.com'
-    @options[:pathname] = opts[:pathname] || '/p/p.svc/Assets/'
-    @options[:time_format] = opts[:time_format] || "%Y-%m-%dT%H:%M:%SZ"
-    @options[:login_domain] = opts[:login_domain] || nil
-    @options[:debug] = opts[:debug] || false
-  end
-
-  def publish(record)
-    # You should set up a record like this:
-    # { :id, :data => [ {:target, :type, :value}, ... ] }
-    puts "Available options: #{@options}" if @options[:debug]
-    @time = Time.now.strftime(@options[:time_format])
-
-    xmls = []
-    record[:data].each do |r|
-      xmls << build_xml(record[:id], r[:target], r[:type], r[:value])
-    end
-
-    post(xmls)
-  end
-
-  private
-
-  def post(data)
-    response_data = []
-    data.each do |xml|
-      req = send_request(xml)
-
-      if req[:code] == "201"
-        puts "===> SUCCESS!" if @options[:debug]
-        response_data << req[:data]
-      else
-        if req[:code] == "401"
-          # TODO: Tell user that we couldn't authenticate
-          puts "===> ERROR! Authentication" if @options[:debug]
-        elsif req[:code] == "400"
-          # TODO: Tell the user there was a formatting error
-          puts "===> ERROR! Formatting" if @options[:debug]
-        else
-          # TODO: Tell the user an unknown error has occured
-          puts "===> ERROR Unknown" if @options[:debug]
-        end
-        response_data = false
-        break
-      end
-    end
-
-    response_data
-  end
-
-  def send_request(body)
-    status = false
-    data = false
-    code = ""
-
-    puts "Initializing request for #{@subdomain + '.' + @options[:domain]}" if @options[:debug]
-    Net::HTTP.start("#{@subdomain}.#{@options[:domain]}", 80) do |http|
-      req = Net::HTTP::Post.new(@options[:pathname])
-
-      req.content_type = 'application/atom+xml'
-      req.content_length = body.size - 20 # Currently a bug with the Pomegranate API I believe
-      req.body = body
-      req.ntlm_auth(@username, @options[:login_domain], @password)
-
-      response = http.request(req)
-      puts response.inspect if @options[:debug]
-
-      code = response.code
-
-      if code == "201"
-        data = parse_xml(response.body)
-      else
-        break
-      end
-    end
-
-    {:code => code, :data => data}
-  end
-
-  def build_xml(record_id, target, type, value)
-    <<-EOF.gsub(/^ {6}/, '')
-      <?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
-      <entry
-        xml:base="/p/p.svc/"
-        xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
-        xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
-        xmlns="http://www.w3.org/2005/Atom">
-        <id></id>
-        <title type="text"></title>
-        <updated>#{@time}</updated>
-        <author><name /></author>
-        <category term="pomegranateModel.Asset" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
-        <content type="application/xml">
-          <m:properties>
-            <d:AssetID>--</d:AssetID>
-            <d:AssetData>#{value}</d:AssetData>
-            <d:AssetType>#{type}</d:AssetType>
-            <d:AssetMeta></d:AssetMeta>
-            <d:AssetRecordID>#{record_id}</d:AssetRecordID>
-            <d:Target>#{target}</d:Target>
-            <d:Client>#{@client_id}</d:Client>
-            <d:Status>APPROVED</d:Status>
-          </m:properties>
-        </content>
-      </entry>
-    EOF
-  end
-
-  def parse_xml(xml)
-    parsed_xml = Nokogiri::XML(xml.gsub(/\n|\r|  /, ""))
-    data = {}
-    parsed_xml.css('m|properties').children.each do |p|
-      data[p.name] = p.content
-    end
-    data
-  end
-end
+require "pomade/version"
+require "pomade/publisher"

data/lib/pomade/publisher.rb

@@ -0,0 +1,202 @@
+require "securerandom"
+require "ntlm/http"
+require "nokogiri"
+
+module Pomade
+  class Publisher
+    # Public: Creates a new instance of Publisher that pushes records to
+    # Pomegranate.
+    # 
+    # Parameters: 
+    #
+    #   subdomain - [string] The subdomain for the Pomegranate instance that 
+    #               you'd like to connect to.
+    #   username  - [string] The username used for connecting to your instance.
+    #   password  - [string] The password used for connecting to your instance.
+    #   client_id - [string] Your client ID.
+    #   opts      - [hash] (optional) Additional options.
+    # 
+    #   Available options are:
+    #   host        - [string] The host (domain name) that Pomegranate lives on.
+    #   pathname    - [string] The path that is used for interacting with
+    #                 Pomegranate.
+    #   time_format - [string] (strftime) change the layout of the timestamp
+    #   domain      - [string] NTLM login domain.
+    #   debug       - [boolean] Turns on debug mode. This will print out
+    #                 any activity.
+    # 
+    # Returns:
+    # 
+    #   Returns an instance of Pomade::Publisher
+    # 
+    # Example:
+    # 
+    #   @pom = Pom.new('my-subdomain', 'myusername', 'mypassword', 'XX')
+    def initialize(subdomain, username, password, client_id, opts = {})
+      @subdomain = subdomain
+      @username = username
+      @password = password
+      @client_id = client_id
+
+      # Other options
+      @options = {}
+      @options[:host] = opts[:host] || 'timessquare2.com'
+      @options[:pathname] = opts[:pathname] || '/p/p.svc/Assets/'
+      @options[:time_format] = opts[:time_format] || "%Y-%m-%dT%H:%M:%SZ"
+      @options[:domain] = opts[:domain] || nil
+      @options[:debug] = opts[:debug] || false
+    end
+
+    # Public: Publishes an array of assets to Pomegranate
+    # 
+    # Parameters:
+    # 
+    #   assets - [array] A collection of assets. Each item consits of a hash with
+    #            three keys: { target: "", type: "", value: "" }
+    # 
+    # Returns:
+    # 
+    #   A hash containing two keys: record_id and assets.
+    # 
+    # Example:
+    # 
+    #   records = [
+    #     { target: "XX~USERNAME", type: "TEXT", value: "jakebellacera"},
+    #     { target: "XX~AVATAR", type: "IMAGE", value: "http://www.gravatar.com/avatar/98363013aa1237798130bc0fd2c4159d.png"}
+    #   ]
+    #   @pom.publish(records)
+    #   #=> {
+    #         record_id: "XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1",
+    #         assets: [
+    #           {"AssetID"=>"9a24c8e2-1066-42fb-be1c-697c5ead476d", "AssetData"=>"jakebellacera", "AssetType"=>"TEXT", "Target"=>"NS~USERNAME", "Client"=>"XX", "Status"=>"APPROVED", "AssetMeta"=>"", "AssetRecordID"=>"XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1"},
+    #           {"AssetID"=>"9a24c8e2-1066-42fb-be1c-697c5ead476d", "AssetData"=>"http://www.gravatar.com/avatar/98363013aa1237798130bc0fd2c4159d.png", "AssetType"=>"IMAGE", "Target"=>"XX~Avatar", "Client"=>"XX", "Status"=>"APPROVED", "AssetMeta"=>"", "AssetRecordID"=>"XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1"}
+    #         ]
+    #       }
+    def publish(assets)
+      puts "Available options: #{@options}" if @options[:debug]
+      @time = Time.now.strftime(@options[:time_format])
+      @record_id = generate_record_id
+
+      xmls = []
+      assets.each do |r|
+        xmls << build_xml(@record_id, r[:target], r[:type].upcase, r[:value])
+      end
+
+      return {
+        record_id: @record_id,
+        assets: post(xmls)
+      }
+    end
+
+    # Public: Generates a record ID
+    #
+    # Parameters:
+    # 
+    #   None
+    #
+    # Returns:
+    # 
+    #   Returns a string containing the client_id with a UUID appended to it.
+    def generate_record_id
+      @client_id + '-' + SecureRandom.uuid
+    end
+
+    private
+
+    def post(data)
+      response_data = []
+      data.each do |xml|
+        puts xml if @options[:debug]
+
+        req = send_request(xml)
+
+        if req[:code] == "201"
+          puts "===> SUCCESS!" if @options[:debug]
+          response_data << req[:data]
+        else
+          if req[:code] == "401"
+            # TODO: Tell user that we couldn't authenticate
+            puts "===> ERROR! Authentication" if @options[:debug]
+          elsif req[:code] == "400"
+            # TODO: Tell the user there was a formatting error
+            puts "===> ERROR! Formatting" if @options[:debug]
+          else
+            # TODO: Tell the user an unknown error has occured
+            puts "===> ERROR Unknown" if @options[:debug]
+          end
+          response_data = false
+          break
+        end
+      end
+
+      response_data
+    end
+
+    def send_request(body)
+      status = false
+      data = false
+      code = ""
+
+      puts "Initializing request for #{@subdomain + '.' + @options[:host]}" if @options[:debug]
+      Net::HTTP.start("#{@subdomain}.#{@options[:host]}", 80) do |http|
+        req = Net::HTTP::Post.new(@options[:pathname])
+
+        req.content_type = 'application/atom+xml'
+        req.content_length = body.size - 20 # Currently a bug with the Pomegranate API I believe
+        req.body = body
+        req.ntlm_auth(@username, @options[:domain], @password)
+
+        response = http.request(req)
+        puts response.inspect if @options[:debug]
+
+        code = response.code
+
+        if code == "201"
+          data = parse_xml(response.body)
+        else
+          break
+        end
+      end
+
+      {:code => code, :data => data}
+    end
+
+    def build_xml(record_id, target, type, value)
+      <<-EOF.gsub(/^ {8}/, '')
+        <?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
+        <entry
+          xml:base="/p/p.svc/"
+          xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
+          xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
+          xmlns="http://www.w3.org/2005/Atom">
+          <id></id>
+          <title type="text"></title>
+          <updated>#{@time}</updated>
+          <author><name /></author>
+          <category term="pomegranateModel.Asset" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
+          <content type="application/xml">
+            <m:properties>
+              <d:AssetID>--</d:AssetID>
+              <d:AssetData>#{value}</d:AssetData>
+              <d:AssetType>#{type}</d:AssetType>
+              <d:AssetMeta></d:AssetMeta>
+              <d:AssetRecordID>#{record_id}</d:AssetRecordID>
+              <d:Target>#{target}</d:Target>
+              <d:Client>#{@client_id}</d:Client>
+              <d:Status>APPROVED</d:Status>
+            </m:properties>
+          </content>
+        </entry>
+      EOF
+    end
+
+    def parse_xml(xml)
+      parsed_xml = Nokogiri::XML(xml.gsub(/\n|\r|  /, ""))
+      data = {}
+      parsed_xml.css('m|properties').children.each do |p|
+        data[p.name] = p.content
+      end
+      data
+    end
+  end
+end

data/lib/pomade/version.rb

@@ -0,0 +1,3 @@
+module Pomade
+  VERSION = "0.1.2"
+end

data/pomade.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pomade/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pomade"
+  gem.version       = Pomade::VERSION
+  gem.authors       = ["Jake Bellacera"]
+  gem.email         = ["hi@jakebellacera.com"]
+  gem.description   = "Pomegranate API Wrapper"
+  gem.summary       = "Ruby wrapper for TimesSquare2's Pomegranate API"
+  gem.homepage      = "http://github.com/jakebellacera/pomade"
+
+  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.add_dependency('ruby-ntlm', '~> 0.0.1')
+  gem.add_dependency('nokogiri', '~> 1.5.5')
+end

data/readme.md

@@ -0,0 +1,88 @@
+# Pomade - The ruby Pomegranate API wrapper
+
+Pomade is a gem that acts as an API wrapper used for interfacing with TimesSquare2's [Pomegranate API](http://api.timessquare2.com/pomegranate/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pomade'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pomade
+
+## Publisher
+
+Publisher lets you publish content to the Pomegranate API.
+
+```ruby
+Pomade::Publisher.new(subdomain, username, password, client_id, options)
+```
+
+#### Available Options
+
+These are the available options and their defaults.
+
+```ruby
+{
+    domain:         'timessquare2.com',     # This string appends to the subdomain
+    pathname:       '/p/p.svc/Assets/',     # The path where you send POST requests to
+    time_format:    "%Y-%m-%dT%H:%M:%SZ",   # strftime format for sending timestamps
+    login_domain:   nil,                    # Optional domain attribute for authenticating via NTLM
+    debug:          false                   # Prints debugging output
+}
+```
+
+To publish assets to Pomegranate, simply create a new Publisher instance.
+
+### Usage
+
+```ruby
+@pom = Pomade::Publisher.new('my-subdomain', 'myusername', 'mypassword', 'XX')
+```
+
+Next, you'll want to push your assets to Pomegranate. You can do this by building an array of hashes. Each item in the array represents a single asset and they each have three keys: **target**, **type** and **value**. You'll pass this array into the `publisher#push` method.
+
+```ruby
+assets = [
+    { target: "XX~USERNAME", type: "TEXT", value: "jakebellacera"},
+    { target: "XX~AVATAR", type: "IMAGE", value: "http://www.gravatar.com/avatar/98363013aa1237798130bc0fd2c4159d.png"}
+]
+
+record = @pom.publish(assets)
+```
+
+The `Publisher#publish` method will return a **record**. A record is a hash with two keys: **record_id** and **assets**. The record_id is a randomly generated UUID string with your client_id prepended to it while the assets array is the posted assets. If assets is false, then the records failed to push to Pomegranate.
+
+```ruby
+puts record
+#=> {
+      record_id: "XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1",
+      assets: [
+        {"AssetID"=>"9a24c8e2-1066-42fb-be1c-697c5ead476d", "AssetData"=>"jakebellacera", "AssetType"=>"TEXT", "Target"=>"NS~USERNAME", "Client"=>"XX", "Status"=>"APPROVED", "AssetMeta"=>"", "AssetRecordID"=>"XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1"},
+        {"AssetID"=>"9a24c8e2-1066-42fb-be1c-697c5ead476d", "AssetData"=>"http://www.gravatar.com/avatar/98363013aa1237798130bc0fd2c4159d.png", "AssetType"=>"IMAGE", "Target"=>"XX~Avatar", "Client"=>"XX", "Status"=>"APPROVED", "AssetMeta"=>"", "AssetRecordID"=>"XX-91c8071a-1201-4f99-bc9d-f8d53a947dc1"}
+      ]
+    }
+```
+
+#### Debugging
+
+Sometimes Pomegranate will not be able to accept your request. If you're getting a 400 error, it's most likely a formatting issue. Since the errors returned by Pomegranate are not very verbose, it's best to run through a simple checklist instead:
+
+* Ensure that your login info is correct. You can test in your browser by logging in via HTTPS at `<subdomain>.timessquare2.com`. If you'd like to use cURL or something else, connect via NTLM.
+* Make sure that the targets and types for each asset are correct. Targets will vary from client to client.
+* Try creating a pomegranate with the `debug` option set to `true` and try again.
+* If all else fails, you can try submitting an [issue](https://github.com/jakebellacera/pomade/issues). Please be specific in your bug report.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pomade
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ntlm
@@ -43,13 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.5
-description: Ruby wrapper for TimeSquare2's Pomegranate API
-email: hi@jakebellacera.com
+description: Pomegranate API Wrapper
+email:
+- hi@jakebellacera.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- Rakefile
 - lib/pomade.rb
+- lib/pomade/publisher.rb
+- lib/pomade/version.rb
+- pomade.gemspec
+- readme.md
 homepage: http://github.com/jakebellacera/pomade
 licenses: []
 post_install_message: 
@@ -61,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -73,6 +82,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Pomegranate API Wrapper
+summary: Ruby wrapper for TimesSquare2's Pomegranate API
 test_files: []
-has_rdoc: false
+has_rdoc: