sifiapi 0.9.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.DS_Store
+.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,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "rspec", "~> 2.7.0"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brandon Aaron
+
+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/README.md

@@ -0,0 +1,83 @@
+# SifiApi
+
+Offers a simple way to interact with the Simpli.fi API via Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sifiapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sifiapi
+
+## Basic Usage
+
+    APPKEY = "your_app_key"
+    connection = SifiApi::Connection.new(APPKEY)
+
+    user = connection.user(user_key, :include => "companies,clients")
+
+    # see available resources
+    puts user.resources
+
+    # get the company and it's client
+    company = user.companies.first
+    client = company.clients.first
+
+## Create, Update, and Destroy Resource
+
+    campaign = client.create(:campaign)
+    campaign.update({ :name => "Testing via API!" })
+    campaign.delete
+
+## Capturing Errors
+
+    # Capture for all resources
+    class SifiApi::Resource
+      rescue_from SifiApi::NotFound, :with => proc{|e| puts "Not found!" }
+      rescue_from SifiApi::UnprocessableEntity, :with => proc{|e| puts "Failed to update!" }
+    end
+
+    # Capture per an individual resource
+    class SifiApi::User
+      rescue_from SifiApi::NotFound, :with => proc{|e| puts "User: Not found!" }
+    end
+
+    # Locally capture an error
+    begin
+      campaign.update({ :bid => "invalid" })
+    rescue SifiApi::UnprocessableEntity => exception
+      puts exception.message
+    end
+
+## Attaching Files to updates
+
+    keywords = campaign.keywords
+    csv = Tempfile.new(['keywords', 'csv'])
+    csv.print("keyword one,2.50\nkeyword two,2.25\nkeyword three,5.00")
+    csv.rewind
+    keywords.update(:csv => csv)
+
+## Downloading Files
+
+    keywords = campaign.keywords
+    csv = keywords.download
+    csv.is_a?(Tempfile) # true
+
+## Ruby Versions
+
+This has been tested against Ruby 1.9.2.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new("spec") do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/examples/complete_workflow.rb

@@ -0,0 +1,93 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'sifiapi'
+require 'date'
+require 'tempfile'
+
+# add application and user api keys
+APPKEY  = 'APPLICATION_KEY_GOES_HERE'
+USERKEY = 'USER_KEY_GOES_HERE'
+
+api = SifiApi::Connection.new(APPKEY)
+# can optionally pass a uri as the second param for the api end point (if you are testing against app-playground for instance)
+#api = SifiApi::Connection.new(APPKEY, "https://app-playground.simpli.fi/api/")
+
+# get the user and include the companies and clients in the result
+user = api.user(USERKEY, :include => "companies,clients")
+
+# grab the first company and the first companies client
+company = user.companies.first
+client = company.clients.first
+
+
+# create a campaign from the client
+search_campaign = client.create(:campaign)
+search_campaign_settings = {
+  :name => "Example Search Campaign via API",
+  :campaign_type_id => 1,
+  :recency_id => 1,
+  :advertiser => "Example Advertiser",
+  :start_date => Date.today.strftime("%Y-%m-%d"),
+  :end_date => (Date.today + 30).strftime("%Y-%m-%d"),
+  :bid_type_id => 1,
+  :bid => 5.00,
+  :daily_budget => 500.00,
+  :dayparting_ids => [1,2],
+  :browser_ids => [601,604],
+  :device_ids => [701],
+  :operating_system_ids => [801],
+  :context_ids => [201,207],
+  :geo_target_ids => [1,8180],
+  :branded_data_ids => ['ECohortsDigital_26','ECohortsDigital_27'],
+  :frequency_capping => { :how_many_times => 1, :hours => 1 },
+  :campaign_goal => { :goal_type => "ctr", :goal_value => 0.05 },
+  :impression_cap => 10000,
+  :pacing => 75
+}
+# update the campaign with the desired settings
+search_campaign.update(search_campaign_settings)
+
+# reload the campaign and include the nested resources
+puts search_campaign.reload(:include => "daypartings,browsers,devices,operating_systems,context_ids,branded_data").inspect
+
+
+# setup an ad
+html_ad_settings = {
+  :name => "Example HTML Ad",
+  :ad_file_type_id => 4,
+  :ad_size_id => 3,
+  :target_url => "http://www.simpli.fi/",
+  :html => "<a href=\"{{clickTag}}\" target=\"_blank\">Simpli.fi</a>"
+}
+search_campaign.create(:ad, html_ad_settings)
+
+puts search_campaign.ads.inspect
+
+# upload some keywords for the campaign
+keywords = search_campaign.keywords.first
+keyword_csv = Tempfile.new(['keywords', 'csv'])
+keyword_csv.print("keyword one,2.50\nkeyword two,2.25\nkeyword three,5.00")
+keyword_csv.rewind
+keywords.update(:csv => keyword_csv)
+
+puts keywords.reload.inspect
+
+# upload some domains
+domains = search_campaign.domains.first
+domain_csv = Tempfile.new(['domains', 'csv'])
+domain_csv.print("http://simpli.fi/")
+domain_csv.rewind
+domains.update(:csv => domain_csv, :list_type => "whitelist")
+
+puts domains.reload.inspect
+
+# upload some ip ranges
+ip_ranges = search_campaign.ip_ranges.first
+ip_ranges_csv = Tempfile.new(['ip_ranges', 'csv'])
+ip_ranges_csv.print("192.168.1.1,192.168.1.9\n192.168.2.1,192.168.2.9")
+ip_ranges_csv.rewind
+ip_ranges.update(:csv => ip_ranges_csv)
+
+puts ip_ranges.reload.inspect
+

data/lib/faraday/request/convert_file_to_upload_io.rb

@@ -0,0 +1,37 @@
+module Faraday
+  class Request::ConvertFileToUploadIO < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        resource = env[:body].keys.first
+        env[:body][resource].each do |key, value|
+          if value.is_a?(File) || value.is_a?(Tempfile)
+            env[:body][resource][key] = Faraday::UploadIO.new(value, mime_type(value.path), value.path)
+          elsif value.is_a?(Hash) && (value['io'].is_a?(IO) || value['io'].is_a?(StringIO))
+            env[:body][resource][key] = Faraday::UploadIO.new(value['io'], mime_type('.'+value['type']), '')
+          end
+        end
+      end
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(path)
+      case path
+      when /\.jpe?g/i
+        'image/jpeg'
+      when /\.gif$/i
+        'image/gif'
+      when /\.png$/i
+        'image/png'
+      when /\.swf$/i
+        'application/swf'
+      when /\.csv$/i
+        'text/csv'
+      else
+        'application/octet-stream'
+      end
+    end
+
+  end
+end

data/lib/faraday/request/json_encode.rb

@@ -0,0 +1,11 @@
+module Faraday
+  class Request::JsonEncode < Faraday::Middleware
+    def call(env)
+      if env[:request_headers]["Content-Type"] == nil
+        env[:body] = MultiJson.encode(env[:body]) if env[:body] != nil
+        env[:request_headers]["Content-Type"] = "application/json"
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/faraday/response/parse_json.rb

@@ -0,0 +1,32 @@
+module Faraday
+  class Response::ParseJson < Faraday::Middleware
+    dependency 'multi_json'
+
+    def call(env)
+      @app.call(env).on_complete do
+        if env[:response_headers]["content-type"].include?("application/json")
+          env[:body] = convert_to_json(env[:body])
+        end
+      end
+    end
+
+    protected
+
+    def convert_to_json(body)
+      case body.strip
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        begin
+          ::MultiJson.decode(body)
+        rescue Exception => exception
+          raise SifiApi::InvalidJson
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_sifi_error.rb

@@ -0,0 +1,37 @@
+module Faraday
+  class Response::RaiseSifiError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise SifiApi::BadRequest, error_message(response)
+      when 401
+        raise SifiApi::Unauthorized, error_message(response)
+      when 403
+        raise SifiApi::Forbidden, error_message(response)
+      when 404
+        raise SifiApi::NotFound, error_message(response)
+      when 406
+        raise SifiApi::NotAcceptable, error_message(response)
+      when 422
+        raise SifiApi::UnprocessableEntity, error_message(response)
+      when 500
+        raise SifiApi::InternalServerError, error_message(response)
+      when 501
+        raise SifiApi::NotImplemented, error_message(response)
+      when 502
+        raise SifiApi::BadGateway, error_message(response)
+      when 503
+        raise SifiApi::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      msg = "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}"
+      if errors = response[:body] && response[:body]["errors"]
+        msg << "\n"
+        msg << errors.join("\n")
+      end
+      msg
+    end
+  end
+end

data/lib/sifi_api/ad.rb

@@ -0,0 +1,2 @@
+class SifiApi::Ad < SifiApi::Resource
+end

data/lib/sifi_api/ad_file_type.rb

@@ -0,0 +1,2 @@
+class SifiApi::AdFileType < SifiApi::Resource
+end

data/lib/sifi_api/ad_size.rb

@@ -0,0 +1,2 @@
+class SifiApi::AdSize < SifiApi::Resource
+end

data/lib/sifi_api/bid_type.rb

@@ -0,0 +1,2 @@
+class SifiApi::BidType < SifiApi::Resource
+end

data/lib/sifi_api/branded_datum.rb

@@ -0,0 +1,2 @@
+class SifiApi::BrandedDatum < SifiApi::Resource
+end

data/lib/sifi_api/browser.rb

@@ -0,0 +1,2 @@
+class SifiApi::Browser < SifiApi::Resource
+end

data/lib/sifi_api/campaign.rb

@@ -0,0 +1,2 @@
+class SifiApi::Campaign < SifiApi::Resource
+end

data/lib/sifi_api/campaign_stat.rb

@@ -0,0 +1,2 @@
+class SifiApi::CampaignStat < SifiApi::Resource
+end

data/lib/sifi_api/campaign_type.rb

@@ -0,0 +1,2 @@
+class SifiApi::CampaignType < SifiApi::Resource
+end

data/lib/sifi_api/change.rb

@@ -0,0 +1,2 @@
+class SifiApi::Change < SifiApi::Resource
+end

data/lib/sifi_api/client.rb

@@ -0,0 +1,2 @@
+class SifiApi::Client < SifiApi::Resource
+end

data/lib/sifi_api/company.rb

@@ -0,0 +1,2 @@
+class SifiApi::Company < SifiApi::Resource
+end

data/lib/sifi_api/connection.rb

@@ -0,0 +1,59 @@
+require 'faraday/request/convert_file_to_upload_io'
+require 'faraday/request/json_encode'
+require 'faraday/response/raise_sifi_error'
+require 'faraday/response/parse_json'
+
+class SifiApi::Connection
+  def initialize(app_key, site="https://app.simpli.fi/api/")
+    @site = site
+    @app_key = app_key
+    @connection = Faraday::Connection.new(:url => site, :ssl => { :verify => false }) do |builder|
+      builder.use Faraday::Request::ConvertFileToUploadIO
+      builder.request  :multipart
+      builder.use Faraday::Request::JsonEncode
+
+      builder.use Faraday::Response::RaiseSifiError
+      builder.use Faraday::Response::ParseJson
+
+      builder.adapter Faraday.default_adapter
+    end
+  end
+
+  def user(user_key, params={})
+    SifiApi::User.get_via_uri(self, user_key, '', params).first
+  end
+
+  def get(user_key, route='', params={}, headers={})
+    begin
+      @connection.run_request(:get, @connection.build_url(route, params), nil, { "X-App-Key" => @app_key, "X-User-Key" => user_key }.merge(headers))
+    rescue Faraday::Error::TimeoutError => e
+      raise SifiApi::Timeout, "Timeout"
+    end
+  end
+
+  def post(user_key, route='', body=nil, headers={})
+    begin
+      @connection.run_request(:post, route, body, { "X-App-Key" => @app_key, "X-User-Key" => user_key }.merge(headers))
+    rescue Faraday::Error::TimeoutError => e
+      raise SifiApi::Timeout, "Timeout"
+    end
+  end
+
+  def put(user_key, route='', body=nil, headers={})
+    begin
+      @connection.run_request(:put, route, body, { "X-App-Key" => @app_key, "X-User-Key" => user_key }.merge(headers))
+    rescue Faraday::Error::TimeoutError => e
+      raise SifiApi::Timeout, "Timeout"
+    end
+  end
+
+  def delete(user_key, route='', body=nil, headers={})
+    begin
+      response = @connection.run_request(:delete, route, body, { "X-App-Key" => @app_key, "X-User-Key" => user_key }.merge(headers))
+      response[:status] == 204
+    rescue Faraday::Error::TimeoutError => e
+      raise SifiApi::Timeout, "Timeout"
+    end
+  end
+
+end

data/lib/sifi_api/context.rb

@@ -0,0 +1,2 @@
+class SifiApi::Context < SifiApi::Resource
+end

data/lib/sifi_api/dayparting.rb

@@ -0,0 +1,2 @@
+class SifiApi::Dayparting < SifiApi::Resource
+end

data/lib/sifi_api/device.rb

@@ -0,0 +1,2 @@
+class SifiApi::Device < SifiApi::Resource
+end

data/lib/sifi_api/dma.rb

@@ -0,0 +1,2 @@
+class SifiApi::Dma < SifiApi::Resource
+end

data/lib/sifi_api/domain.rb

@@ -0,0 +1,2 @@
+class SifiApi::Domain < SifiApi::Resource
+end

data/lib/sifi_api/error.rb

@@ -0,0 +1,15 @@
+module SifiApi
+  class Error < StandardError; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+  class NotAcceptable < Error; end
+  class UnprocessableEntity < Error; end
+  class InternalServerError < Error; end
+  class NotImplemented < Error; end
+  class BadGateway < Error; end
+  class ServiceUnavailable < Error; end
+  class InvalidJson < Error; end
+  class Timeout < Error; end
+end

data/lib/sifi_api/geo_target.rb

@@ -0,0 +1,2 @@
+class SifiApi::GeoTarget < SifiApi::Resource
+end

data/lib/sifi_api/ip_range.rb

@@ -0,0 +1,2 @@
+class SifiApi::IpRange < SifiApi::Resource
+end

data/lib/sifi_api/keyword.rb

@@ -0,0 +1,2 @@
+class SifiApi::Keyword < SifiApi::Resource
+end

data/lib/sifi_api/keyword_category.rb

@@ -0,0 +1,2 @@
+class SifiApi::KeywordCategory < SifiApi::Resource
+end

data/lib/sifi_api/operating_system.rb

@@ -0,0 +1,2 @@
+class SifiApi::OperatingSystem < SifiApi::Resource
+end

data/lib/sifi_api/recency.rb

@@ -0,0 +1,2 @@
+class SifiApi::Recency < SifiApi::Resource
+end

data/lib/sifi_api/recurring_report.rb

@@ -0,0 +1,2 @@
+class SifiApi::RecurringReport < SifiApi::Resource
+end

data/lib/sifi_api/report.rb

@@ -0,0 +1,2 @@
+class SifiApi::Report < SifiApi::Resource
+end

data/lib/sifi_api/report_asset.rb

@@ -0,0 +1,2 @@
+class SifiApi::ReportAsset < SifiApi::Resource
+end

data/lib/sifi_api/report_type.rb

@@ -0,0 +1,2 @@
+class SifiApi::ReportType < SifiApi::Resource
+end