populr 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "rest-client", ">= 1.6"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.5"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.4.0)
+      mocha (~> 0.13.2)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    metaclass (0.0.1)
+    mime-types (1.19)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda (3.4.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 1.0, >= 1.4.1)
+    shoulda-context (1.1.1)
+    shoulda-matchers (1.5.6)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.5)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rest-client (>= 1.6)
+  shoulda

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011- Project 10k, Inc. (https://populr.me)
+
+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.rdoc

@@ -0,0 +1,19 @@
+= Populr.me Ruby Gem
+
+A rubygem for interacting with the Populr.me API from Ruby apps.
+
+== Contributing to the Populr.me Ruby Gem
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Project 10K. See LICENSE.md for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+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 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "populr"
+  gem.homepage = "http://github.com/bengotow/populr"
+  gem.license = "MIT"
+  gem.summary = %Q{Gem for interacting with the Populr.me API}
+  gem.description = %Q{Gem for interacting with the Populr.me API}
+  gem.email = "ben@populr.me"
+  gem.authors = ["Ben Gotow"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "populr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/asset.rb

@@ -0,0 +1,24 @@
+require 'restful_model'
+
+class Asset < RestfulModel
+
+  attr_accessor :description
+  attr_accessor :title
+
+  # as an alternative to calling Asset.new, you can call populr.images.build
+  def initialize(api, file, title = nil, description = nil)
+    super(api)
+
+    @file = file
+    self.title = title
+    self.description = description
+    self.link = link
+  end
+
+  def to_json(options = {})
+    hash = super(options)
+    hash[:file] = @file if options[:api_representation] && @file
+    hash
+  end
+
+end

data/lib/document_asset.rb

@@ -0,0 +1,10 @@
+require 'asset'
+
+class DocumentAsset < Asset
+
+  def self.collection_name
+    "documents"
+  end
+
+end
+

data/lib/domain.rb

@@ -0,0 +1,7 @@
+class Domain < String
+
+  def self.collection_name
+    "domains"
+  end
+
+end

data/lib/image_asset.rb

@@ -0,0 +1,12 @@
+require 'asset'
+
+class ImageAsset < Asset
+
+  attr_accessor :link
+
+  def self.collection_name
+    "images"
+  end
+
+end
+

data/lib/pop.rb

@@ -0,0 +1,93 @@
+require 'restful_model'
+require 'tracer'
+
+class Pop < RestfulModel
+
+  class TemplateRequired < StandardError; end
+
+  attr_accessor :template_id
+  attr_accessor :name
+  attr_accessor :title
+  attr_accessor :slug
+  attr_accessor :label_names
+  attr_accessor :tracers
+  attr_accessor :published_pop_url
+  attr_accessor :unpopulated_api_regions
+  attr_accessor :unpopulated_api_tags
+  attr_accessor :domain
+  attr_accessor :password
+
+  attr_reader :newly_populated_regions
+  attr_reader :newly_populated_tags
+
+  def initialize(api_or_template, template = nil)
+    template = template || api_or_template
+
+    if template.is_a?(Template)
+      self.template_id = template._id
+      @_api = template._api
+    else
+      @_api = api_or_template
+    end
+
+    @newly_populated_regions = {}
+    @newly_populated_tags = {}
+  end
+
+  def inflate(json)
+    super(json)
+
+    collection = RestfulModelCollection.new(Tracer, @_api, self)
+    collection.inflate_collection(self.tracers) if self.tracers
+    self.tracers = collection
+
+    @newly_populated_regions = {}
+    @newly_populated_tags = {}
+  end
+
+  def as_json(options = {})
+    raise TemplateRequired.new unless template_id
+
+    if options[:api_representation]
+      hash = {}
+      hash[:pop] = super(options)
+      hash[:populate_tags] = @newly_populated_tags
+      hash[:populate_regions] = @newly_populated_regions
+      hash
+    else
+      super(options)
+    end
+  end
+
+
+  def publish!
+    update('POST', 'publish')
+  end
+
+  def unpublish!
+    update('POST', 'unpublish')
+  end
+
+  def has_unpopulated_region(region_identifier)
+    self.unpopulated_api_regions.include?(region_identifier)
+  end
+
+  def populate_region(region_identifier, assets)
+    assets = [assets] unless assets.is_a?(Array)
+
+    @newly_populated_regions[region_identifier] ||= []
+    @newly_populated_regions[region_identifier].concat(assets.map {|a| a._id })
+    self.unpopulated_api_regions.delete(region_identifier)
+  end
+
+  def has_unpopulated_tag(tag_identifier)
+    self.unpopulated_api_tags.include?(tag_identifier)
+  end
+
+  def populate_tag(tag_identifier, tag_contents)
+    @newly_populated_tags[tag_identifier] = tag_contents
+    self.unpopulated_api_tags.delete(tag_identifier)
+  end
+
+
+end

data/lib/populr.rb

@@ -0,0 +1,70 @@
+require 'rest-client'
+require 'restful_model_collection'
+require 'template'
+require 'document_asset'
+require 'image_asset'
+require 'json'
+require 'pop'
+require 'domain'
+
+
+class Populr
+
+  class AccessDenied < StandardError; end
+  class ResourceNotFound < StandardError; end
+  class UnexpectedResponse < StandardError; end
+
+  attr_accessor :api_server
+  attr_reader :api_key
+
+
+  def self.interpret_response(result, options = {})
+    # Handle HTTP errors and RestClient errors
+    raise ResourceNotFound.new if result.code.to_i == 404
+    raise AccessDenied.new if result.code.to_i == 403
+    raise UnexpectedResponse.new(result.msg) if result.is_a?(Net::HTTPClientError)
+
+    # Hande content expectation errors
+    raise UnexpectedResponse.new if options[:expected_class] && result.body.empty?
+    json = JSON.parse(result.body)
+    raise UnexpectedResponse.new if options[:expected_class] && !json.is_a?(options[:expected_class])
+    json
+
+  rescue JSON::ParserError => e
+    # Handle parsing errors
+    raise UnexpectedResponse.new(e.message)
+  end
+
+
+
+  def initialize(api_key)
+    @api_server = "api.lvh.me:3000"
+    @api_key = api_key
+  end
+
+  def templates
+    RestfulModelCollection.new(Template, self)
+  end
+
+  def pops
+    RestfulModelCollection.new(Pop, self)
+  end
+
+  def domains
+    RestfulModelCollection.new(Domain, self)
+  end
+
+  def documents
+    RestfulModelCollection.new(DocumentAsset, self)
+  end
+
+  def images
+    RestfulModelCollection.new(ImageAsset, self)
+  end
+
+  def url_for_path(path)
+    "http://#{@api_key}:@#{api_server}#{path}"
+  end
+
+
+end

data/lib/restful_model.rb

@@ -0,0 +1,64 @@
+class RestfulModel
+
+  attr_accessor :_id
+  attr_accessor :created_at
+
+  def self.collection_name
+    "#{self.to_s.downcase}s"
+  end
+
+
+  def initialize(api)
+    @_api = api
+  end
+
+  def ==(comparison_object)
+    comparison_object.equal?(self) || (comparison_object.instance_of?(self.class) && comparison_object._id == _id)
+  end
+
+  def inflate(json)
+    setters = methods.grep(/^\w+=$/)
+    setters.each do |setter|
+      property_name = setter.to_s[0..setter.to_s.index('=')-1]
+      self.send(setter, json[property_name]) if json.has_key?(property_name)
+    end
+    self.created_at = Time.new(self.created_at) if self.created_at
+  end
+
+  def save!
+    if _id
+      update('PUT', '', self.as_json(:api_representation => true))
+    else
+      update('POST', '', self.as_json(:api_representation => true))
+    end
+  end
+
+  def as_json(options = {})
+    hash = {}
+    setters = methods.grep(/^\w+=$/)
+    setters.each do |setter|
+      getter = setter.to_s[0..setter.to_s.index('=')-1]
+      hash[getter] = self.send(getter)
+    end
+    hash
+  end
+
+  def update(http_method, action, data = {})
+    http_method = http_method.downcase
+    action_url = @_api.url_for_path(self.path(action))
+
+    RestClient.send(http_method, action_url, data){ |response,request,result|
+      json = Populr.interpret_response(result, {:expected_class => Object})
+      inflate(json)
+    }
+    self
+  end
+
+  def path(action = "")
+    action = "/#{action}" unless action.empty?
+    prefix = @_parent ? @_parent.path : ''
+    "#{prefix}/#{self.class.collection_name}/#{_id}#{action}"
+  end
+
+
+end

data/lib/restful_model_collection.rb

@@ -0,0 +1,85 @@
+require 'restful_model'
+
+class RestfulModelCollection
+
+  def initialize(model_class, api, parent = nil)
+    @model_class = model_class
+    @_parent = parent
+    @_collection = nil
+    @_api = api
+  end
+
+  def all
+    return @_collection if @_collection
+    get_restful_model_collection
+  end
+
+  def first
+    all.first
+  end
+
+  def find(id)
+    get_restful_model(id)
+  end
+
+  def build(*args)
+    @model_class.new(@_api, *args)
+  end
+
+  def as_json(options = {})
+    objects = []
+    for model in self.all
+      objects.push(model.as_json(options))
+    end
+    objects
+  end
+
+  def inflate_collection(items = [])
+    @_collection = []
+    items.each do |json|
+      if @model_class < RestfulModel
+        model = @model_class.new(self)
+        model.instance_variable_set(:@_parent, @_parent)
+        model.inflate(json)
+      else
+        model = @model_class.new(json)
+      end
+      @_collection.push(model)
+    end
+    @_collection
+  end
+
+  def path(id = "")
+    prefix = @_parent ? @_parent.path : ''
+    "#{prefix}/#{@model_class.collection_name}/#{id}"
+  end
+
+  private
+
+  def get_restful_model(id)
+    model = nil
+    url = @_api.url_for_path(self.path(id))
+
+    RestClient.get(url){ |response,request,result|
+      json = Populr.interpret_response(result, {:expected_class => Object})
+      if @model_class < RestfulModel
+        model = @model_class.new(self)
+        model.inflate(json)
+      else
+        model = @model_class.new(json)
+      end
+    }
+    model
+  end
+
+  def get_restful_model_collection
+    url = @_api.url_for_path(self.path)
+
+    RestClient.get(url){ |response,request,result|
+      items = Populr.interpret_response(result, {:expected_class => Array})
+      inflate_collection(items)
+    }
+    @_collection
+  end
+
+end

data/lib/template.rb

@@ -0,0 +1,10 @@
+require 'restful_model'
+
+class Template < RestfulModel
+
+  attr_accessor :name
+  attr_accessor :label_names
+  attr_accessor :api_tags
+  attr_accessor :api_regions
+
+end

data/lib/tracer.rb

@@ -0,0 +1,58 @@
+require 'restful_model'
+
+class Tracer < RestfulModel
+
+  class CodeCannotBeModified < StandardError; end
+
+  attr_accessor :name
+  attr_accessor :code
+  attr_accessor :notify_on_open
+  attr_accessor :notify_webhook
+  attr_accessor :analytics
+
+  def views
+    return analytics["views"].to_i
+  end
+
+  def clicks
+    return analytics["clicks"].to_i
+  end
+
+  def clicks_for_region(region_id)
+    return 0 unless analytics["assets"] && analytics["assets"][region_id]
+
+    clicks = 0
+    for key, asset in analytics["assets"][region_id]
+      clicks += asset["clicks"].to_i
+    end
+    clicks
+  end
+
+  def clicks_for_link(link)
+    return 0 unless analytics["links"] && analytics["links"][link]
+    return analytics["links"][link]["clicks"].to_i
+  end
+
+  def clicks_for_asset(asset_or_id)
+    return 0 unless analytics["assets"]
+    asset_id = asset_or_id.is_a?(Asset) ? asset_or_id._id : asset_or_id
+
+    for region, assets in analytics["assets"]
+      for key, asset in assets
+        return asset["clicks"].to_i if key == asset_id
+      end
+    end
+    return 0
+  end
+
+  def code=(c)
+    raise CodeCannotBeModified.new if self.code && c != self.code
+    @code = c
+  end
+
+  def enable_webhook(url)
+    self.notify_on_open = true
+    self.notify_webhook = url
+  end
+
+end

data/spec/pop_spec.rb

@@ -0,0 +1,157 @@
+::ENV['RACK_ENV'] = 'test'
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'rack/test'
+
+describe 'Pop' do
+  include Rack::Test::Methods
+  before (:each) do
+    @api = Populr.new('key')
+  end
+
+  describe "#inflate" do
+    it "should inflate tracers into embedded tracer objects" do
+      pop = Pop.new(@api)
+      pop.inflate(JSON.parse("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}"))
+      pop.tracers.first.is_a?(Tracer).should == true
+      pop.tracers.first.name.should == 'Facebook'
+    end
+
+    it "should set the tracer collection's _parent so the tracer's path returns the full nested path" do
+      pop = Pop.new(@api)
+      pop.inflate(JSON.parse("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}"))
+      pop.tracers.path.should == "/pops/#{pop._id}/tracers/"
+    end
+  end
+
+  describe "#path_for_model" do
+    it "should lowercase the classname and pluralize it to create the path" do
+      pop = Pop.new(@api)
+      pop._id = '123'
+      pop.path.should == '/pops/123'
+    end
+  end
+
+  describe "#publish!" do
+    before (:each) do
+      @pop = Pop.new(@api)
+      @pop.inflate(JSON.parse("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}"))
+
+      @result = double('result')
+      @result.stub(:code).and_return(200)
+      @result.stub(:body).and_return("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}")
+      RestClient.stub(:post).and_yield(nil, nil, @result)
+    end
+
+    it "should call update with the publish action" do
+      @pop.should_receive(:update).with('POST', 'publish')
+      @pop.publish!
+    end
+
+    it "should return the pop" do
+      @pop.publish!.should == @pop
+    end
+
+    it "should set the published_pop_url" do
+      @pop.published_pop_url.empty?.should == true
+      @pop.publish!
+      @pop.published_pop_url.empty?.should == false
+    end
+  end
+
+
+  describe "#unpublish!" do
+    before (:each) do
+      @pop = Pop.new(@api)
+      @pop.inflate(JSON.parse("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}"))
+
+      @result = double('result')
+      @result.stub(:code).and_return(200)
+      @result.stub(:body).and_return("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}")
+      RestClient.stub(:post).and_yield(nil, nil, @result)
+    end
+
+    it "should call update with the unpublish action" do
+      @pop.should_receive(:update).with('POST', 'unpublish')
+      @pop.unpublish!
+    end
+
+    it "should return the pop" do
+      @pop.unpublish!.should == @pop
+    end
+
+    it "should set the published_pop_url" do
+      @pop.published_pop_url.empty?.should == false
+      @pop.unpublish!
+      @pop.published_pop_url.empty?.should == true
+    end
+  end
+
+
+  describe "Populating Assets and Regions" do
+    before (:each) do
+      @pop = Pop.new(@api)
+      @pop.inflate(JSON.parse("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[\"tag1\"],\"unpopulated_api_regions\":[\"region1\"],\"label_names\":[]}"))
+
+      @asset = double('asset')
+      @asset.stub(:_id).and_return('asset_id')
+    end
+
+    describe "#populate_region" do
+      context "when a single asset is provided" do
+        it "should add the ID of the provided asset to the newly_populated_regions hash" do
+          @pop.populate_region('region1', @asset)
+          @pop.newly_populated_regions['region1'].should == ['asset_id']
+        end
+      end
+
+      context "when an array of assets is provided" do
+        it "should add the IDs of the provided assets to the newly_populated_regions hash" do
+          @pop.populate_region('region1', [@asset])
+          @pop.newly_populated_regions['region1'].should == ['asset_id']
+        end
+      end
+
+      it "should remove the region identifier from the list of unpopulated regions" do
+        @pop.unpopulated_api_regions.include?('region1').should == true
+        @pop.populate_region('region1', @asset)
+        @pop.unpopulated_api_regions.include?('region1').should == false
+      end
+    end
+
+
+    describe "#has_unpopulated_region" do
+      it "should return true if the region identifier is unpopulated" do
+        @pop.has_unpopulated_region('region1').should == true
+      end
+
+      it "should return false otherwise" do
+        @pop.has_unpopulated_region('region2').should == false
+      end
+    end
+
+
+    describe "#populate_tag" do
+      it "should add the identifier -> value pair to the newly populated tags array" do
+        @pop.populate_tag('tag1', 'content')
+        @pop.newly_populated_tags.should == {'tag1' => 'content'}
+      end
+
+      it "should remove the identifier from the unpopulated_api_tags array" do
+        @pop.unpopulated_api_tags.include?('tag1').should == true
+        @pop.populate_tag('tag1', 'content')
+        @pop.unpopulated_api_tags.include?('tag1').should == false
+      end
+    end
+
+    describe "#has_unpopulated_tag" do
+      it "should return true if the tag identifier is unpopulated" do
+        @pop.has_unpopulated_tag('tag1').should == true
+      end
+
+      it "should return false otherwise" do
+        @pop.has_unpopulated_tag('tag2').should == false
+      end
+    end
+  end
+
+end

data/spec/populr_spec.rb

@@ -0,0 +1,89 @@
+::ENV['RACK_ENV'] = 'test'
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'rack/test'
+
+describe 'Populr' do
+  include Rack::Test::Methods
+
+  before (:each) do
+    @api_key = 'UXXMOCJW-BKSLPCFI-UQAQFWLO'
+    @populr = Populr.new(@api_key)
+  end
+
+  describe '#templates' do
+    it "should return a model collection" do
+      @populr.templates.is_a?(RestfulModelCollection).should == true
+    end
+  end
+
+
+  describe '#pops' do
+    it "should return a model collection" do
+      @populr.templates.is_a?(RestfulModelCollection).should == true
+    end
+  end
+
+  describe "#url_for_path" do
+    it "should return the url for a provided path" do
+      @populr.url_for_path('/wobble').should == "http://#{@populr.api_key}:@#{@populr.api_server}/wobble"
+    end
+  end
+
+  describe "#self.interpret_response" do
+    before (:each) do
+      @result = double('result')
+      @result.stub(:body).and_return("")
+      @result.stub(:code).and_return(200)
+    end
+
+    context "when an expected_class is provided" do
+      context "when the server responds with a 200 but unknown, invalid body" do
+        it "should raise an UnexpectedResponse" do
+          @result.stub(:body).and_return("I AM NOT JSON")
+          lambda {
+            Populr.interpret_response(@result, {:expected_class => Array})
+          }.should raise_error(Populr::UnexpectedResponse)
+        end
+      end
+
+      context "when the server responds with JSON that does not represent an array" do
+        it "should raise an UnexpectedResponse" do
+          @result.stub(:body).and_return("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}")
+          @result.stub(:code).and_return(500)
+          lambda {
+            Populr.interpret_response(@result, {:expected_class => Array})
+          }.should raise_error(Populr::UnexpectedResponse)
+        end
+      end
+    end
+
+    context "when the server responds with a 403" do
+      it "should raise AccessDenied" do
+        @result.stub(:code).and_return(403)
+        lambda {
+          Populr.interpret_response(@result)
+        }.should raise_error(Populr::AccessDenied)
+      end
+    end
+
+    context "when the server responds with a 404" do
+      it "should raise ResourceNotFound" do
+        @result.stub(:code).and_return(404)
+        lambda {
+          Populr.interpret_response(@result)
+        }.should raise_error(Populr::ResourceNotFound)
+      end
+    end
+
+    context "when the server responds with another status code" do
+      it "should raise an UnexpectedResponse" do
+        @result.stub(:code).and_return(500)
+        lambda {
+          Populr.interpret_response(@result)
+        }.should raise_error(Populr::UnexpectedResponse)
+      end
+    end
+
+  end
+
+end

data/spec/restful_model_collection_spec.rb

@@ -0,0 +1,119 @@
+::ENV['RACK_ENV'] = 'test'
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'rack/test'
+
+describe 'RestfulModelCollection' do
+  include Rack::Test::Methods
+
+  before (:each) do
+    @api_key = 'UXXMOCJW-BKSLPCFI-UQAQFWLO'
+    @populr = Populr.new(@api_key)
+    @collection = @populr.pops
+  end
+
+  describe "#all" do
+    it "should call interpret_response to handle standard error cases" do
+      Populr.should_receive(:interpret_response).and_return([])
+      templates = @populr.templates.all
+    end
+
+    context "when the model class is a RestfulModel" do
+      context "when the server responds correctly" do
+        before (:each) do
+          result = double('result')
+          result.stub(:body).and_return("[{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}]")
+          result.stub(:code).and_return(200)
+          RestClient.should_receive(:get).and_yield(nil, nil, result)
+        end
+
+        it "should return an array of model objects" do
+          pops = @collection.all
+          pops.count.should == 1
+          pops.first.is_a?(RestfulModel).should == true
+        end
+
+        it "should call inflate on each model object" do
+          Pop.any_instance.should_receive(:inflate)
+          pops = @collection.all
+        end
+      end
+    end
+
+    context "when the model class is not a restfulModel" do
+      it "should return the same data type in the JSON" do
+        result = double('result')
+        result.stub(:body).and_return("[\"a\",\"b\",\"c\"]")
+        result.stub(:code).and_return(200)
+        RestClient.should_receive(:get).and_yield(nil, nil, result)
+        @populr.domains.all.should == ['a','b','c']
+      end
+    end
+  end
+
+  describe "#first" do
+    it "should return the first item in the all collection" do
+      @collection.first.should == @collection.all.first
+    end
+  end
+
+  describe "#find" do
+    it "should call interpret_response to handle standard error cases" do
+      Populr.should_receive(:interpret_response).and_return({})
+      @populr.pops.find('123')
+    end
+
+    context "when the server responds correctly" do
+      before (:each) do
+        result = double('result')
+        result.stub(:body).and_return("{\"_id\":\"5107089add02dcaecc000003\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}")
+        result.stub(:code).and_return(200)
+        RestClient.should_receive(:get).and_yield(nil, nil, result)
+      end
+
+      it "should return a pop" do
+        pop = @collection.find('5107089add02dcaecc000003')
+        pop.is_a?(Pop).should == true
+        pop._id.should == '5107089add02dcaecc000003'
+      end
+    end
+  end
+
+  describe "#build" do
+    it "should create a new instance of the model object" do
+      parameter1 = double('parameter1')
+      image = @populr.images.build(parameter1)
+      image.is_a?(ImageAsset).should == true
+    end
+
+    it "should pass the api reference, and then any provided arguments" do
+      parameter1 = double('parameter1')
+      ImageAsset.any_instance.should_receive(:initialize).with(@populr, parameter1)
+      @populr.images.build(parameter1)
+    end
+  end
+
+  describe "#as_json" do
+    before (:each) do
+      result = double('result')
+      result.stub(:body).and_return("[{\"_id\":\"5107089add02dcaecc000003\",\"template_id\":\"5107089add02dcaecc000001\",\"created_at\":\"2013-01-28T23:24:10Z\",\"domain\":\"generic\",\"name\":\"Untitled\",\"password\":null,\"slug\":\"\",\"tracers\":[{\"_id\":\"5109b5e0dd02dc5976000001\",\"created_at\":\"2013-01-31T00:08:00Z\",\"name\":\"Facebook\"},{\"_id\":\"5109b5f5dd02dc4c43000002\",\"created_at\":\"2013-01-31T00:08:21Z\",\"name\":\"Twitter\"}],\"published_pop_url\":\"http://group3.lvh.me\",\"unpopulated_api_tags\":[],\"unpopulated_api_regions\":[],\"label_names\":[]}]")
+      result.stub(:code).and_return(200)
+      RestClient.should_receive(:get).and_yield(nil, nil, result)
+    end
+
+    it "should call as_json for each model in the collection" do
+      Pop.any_instance.should_receive(:as_json)
+      @collection.as_json
+    end
+
+    it "should return an array of hashes" do
+      @collection.as_json.count.should == 1
+      @collection.as_json.first['_id'].should == '5107089add02dcaecc000003'
+    end
+
+    it "should forward options to each model" do
+      Pop.any_instance.should_receive(:as_json).with(:bla => true)
+      @collection.as_json(:bla => true)
+    end
+  end
+
+end

data/spec/restful_model_spec.rb

@@ -0,0 +1,20 @@
+::ENV['RACK_ENV'] = 'test'
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'rack/test'
+
+describe 'RestfulModel' do
+  include Rack::Test::Methods
+  before (:each) do
+    @api = Populr.new('key')
+  end
+
+  describe "#as_json" do
+    it "should return a hash with the attr_accessor properties" do
+      r = RestfulModel.new(@api)
+      r._id = '1'
+      r.created_at = Time.new
+      r.as_json.should == {"_id" => "1", "created_at" => r.created_at}
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'pry'
+require 'pry-nav'
+require 'pry-stack_explorer'
+require 'populr'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/tracer_spec.rb

@@ -0,0 +1,107 @@
+::ENV['RACK_ENV'] = 'test'
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'rack/test'
+
+describe 'Pop' do
+  include Rack::Test::Methods
+  before (:each) do
+    @api = Populr.new('key')
+    @tracer = Tracer.new(@api)
+    @tracer.inflate(JSON.parse("{\"code\":\"tc\",\"name\":\"Twitter\",\"notify_on_open\":false,\"analytics\":{\"views\":6,\"clicks\":24,\"links\":{\"http://www.populr.me/\":{\"clicks\":4}},\"assets\":{\"empty_region\":{},\"unnamed_region_0\":{\"132213ae12bc1312\":{\"clicks\":10}},\"my_image_region\":{\"132213ae21f4812f\":{\"clicks\":10},\"f48121f48121f421\":{\"clicks\":3}}}}}"))
+  end
+
+
+  describe "#views" do
+    it "should retrieve the total views from analytics" do
+      @tracer.views.should == 6
+    end
+  end
+
+  describe "#clicks" do
+    it "should retrieve the total clicks from analytics" do
+      @tracer.clicks.should == 24
+    end
+  end
+
+  describe "#clicks_for_region" do
+    it "should sum the clicks for all assets in the region" do
+      @tracer.clicks_for_region('my_image_region').should == 13
+    end
+
+    it "should return 0 if the region does not exist" do
+      @tracer.clicks_for_region('nonexistent_region').should == 0
+    end
+
+    it "shoud return 0 if the region has no assets" do
+      @tracer.clicks_for_region('empty_region').should == 0
+    end
+
+    it "should return 0 if the assets section of analytics is not present" do
+      @tracer.inflate(JSON.parse("{\"code\":\"tc\",\"name\":\"Twitter\",\"notify_on_open\":false,\"analytics\":{\"views\":6,\"clicks\":24,\"links\":{\"http://www.populr.me/\":{\"clicks\":4}}}}"))
+      @tracer.clicks_for_region('my_image_region').should == 0
+    end
+  end
+
+  describe "#clicks_for_link" do
+    it "should return the analytics clicks value if the link exists" do
+      @tracer.clicks_for_link('http://www.populr.me/').should == 4
+    end
+
+    it "should return 0 if the link does not exist" do
+      @tracer.clicks_for_link('http://www.nonexistent.com/').should == 0
+    end
+
+    it "should return 0 if the link hash is not present" do
+      @tracer.inflate(JSON.parse("{\"code\":\"tc\",\"name\":\"Twitter\",\"notify_on_open\":false,\"analytics\":{\"views\":6,\"clicks\":24}}"))
+      @tracer.clicks_for_link('http://www.populr.com/').should == 0
+    end
+  end
+
+  describe "#clicks_for_asset" do
+    it "should scan through the regions in the analytics hash and return the asset clicks" do
+      @tracer.clicks_for_asset('132213ae21f4812f').should == 10
+    end
+
+    it "should return 0 if the assets section of analytics is not present" do
+      @tracer.inflate(JSON.parse("{\"code\":\"tc\",\"name\":\"Twitter\",\"notify_on_open\":false,\"analytics\":{\"views\":6,\"clicks\":24,\"links\":{\"http://www.populr.me/\":{\"clicks\":4}}}}"))
+      @tracer.clicks_for_asset('132213ae21f4812f').should == 0
+    end
+
+    it "should return 0 if there is no matching asset" do
+      @tracer.clicks_for_asset('asd').should == 0
+    end
+
+    it "should accept an asset object as a parameter" do
+      asset = ImageAsset.new(@api, nil)
+      asset._id = '132213ae21f4812f'
+      @tracer.clicks_for_asset(asset).should == 10
+    end
+
+    it "should accept an asset id as a parameter" do
+      @tracer.clicks_for_asset('132213ae21f4812f').should == 10
+    end
+  end
+
+  describe "#enable_webhook" do
+    it "should set the webhook and enable notify_on_open" do
+      @webhook = 'http://mycallback.com'
+
+      @tracer.notify_on_open.should == false
+      @tracer.enable_webhook(@webhook)
+      @tracer.notify_on_open.should == true
+      @tracer.notify_webhook.should == @webhook
+    end
+  end
+
+  describe "#code=" do
+    it "should only allow the tracer code to be set if there isn't a value" do
+      @tracer = Tracer.new(@api)
+      @tracer.code.should == nil
+      @tracer.code = 'as'
+
+      lambda {
+        @tracer.code = 'bb'
+      }.should raise_error(Tracer::CodeCannotBeModified)
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: populr
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Gotow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Gem for interacting with the Populr.me API
+email: ben@populr.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/asset.rb
+- lib/document_asset.rb
+- lib/domain.rb
+- lib/image_asset.rb
+- lib/pop.rb
+- lib/populr.rb
+- lib/restful_model.rb
+- lib/restful_model_collection.rb
+- lib/template.rb
+- lib/tracer.rb
+- spec/pop_spec.rb
+- spec/populr_spec.rb
+- spec/restful_model_collection_spec.rb
+- spec/restful_model_spec.rb
+- spec/spec_helper.rb
+- spec/tracer_spec.rb
+homepage: http://github.com/bengotow/populr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1796578390559359755
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for interacting with the Populr.me API
+test_files: []