sifiapi 0.9.0

data/lib/sifi_api/resource.rb

@@ -0,0 +1,150 @@
+require 'tempfile'
+
+class SifiApi::Resource
+  include ActiveSupport::Rescuable
+
+  def initialize(json, connection, user_key)
+    @json = json
+    @connection = connection
+    @user_key = user_key
+    @cache = {}
+  end
+
+  def raw_json
+    @json
+  end
+
+  def update(params={})
+    params = { resource_name.singularize => params }
+    execute_with_rescue do
+      response = @connection.put(@user_key, self.resource, params)
+      if response && response.body
+        @json = response.body[resource_name].first
+      end
+    end
+    self
+  end
+
+  def create(resource, params={})
+    params = { resource => params }
+    execute_with_rescue do
+      resource_name = resource.to_s.pluralize
+      response = @connection.post(@user_key, self.resource + "/#{resource_name}", params)
+      if response && response.body
+        record = response.body[resource_name].first
+        SifiApi.const_get(resource.to_s.classify).new(record, @connection, @user_key)
+      end
+    end
+  end
+
+  def find(resource, id)
+    execute_with_rescue do
+      resource_name = resource.to_s.pluralize
+      record = @connection.get(@user_key, self.resource + "/#{resource_name}").body[resource_name].select{|x| x["id"].to_i == id.to_i }.first
+      record ? SifiApi.const_get(resource.to_s.classify).new(record, @connection, @user_key) : []
+    end
+  end
+
+  def delete
+    execute_with_rescue do
+      @connection.delete(@user_key, self.resource)
+    end
+  end
+
+  def reload(params={})
+    execute_with_rescue do
+      response = @connection.get(@user_key, self.resource, params)
+      if response && response.body
+        @json = response.body[resource_name].first
+        @cache = {}
+      end
+    end
+    self
+  end
+
+  def self.get_via_uri(connection, user_key, uri='', params={})
+    a = []
+    response = connection.get(user_key, uri, params)
+    if response && response.body
+      response.body[resource_name].each do |record|
+        resource = self.new(record, connection, user_key)
+        a << resource
+      end
+    end
+    a
+  end
+
+  def method_missing(sym, *args, &block)
+    if @json.respond_to?(sym)
+      @json.send(sym, *args, &block)
+    elsif val = (@json["resources"] || []).select { |r| r[sym.to_s] }.first
+      return get_resource(sym.to_s, val[sym.to_s], *args)
+    elsif @json.has_key?(sym.to_s)
+      return @json[sym.to_s]
+    elsif val = (@json["actions"] || []).select { |a| a[sym.to_s] }.first
+      return do_action(val[sym.to_s])
+    else
+      super(sym, *args, &block)
+    end
+  end
+
+
+  def do_action(action)
+    execute_with_rescue do
+      response = @connection.send(action["method"].downcase, @user_key, action["href"])
+      if response && response.status == 200
+        if response[:content_type] == "application/json"
+          @json = response.body[resource_name].first
+        elsif ["text/csv", "application/zip"].include?(response[:content_type])
+          filename = response.headers[:content_disposition].match(/filename="(.+)"/)[1]
+          file = Tempfile.new(filename)
+          file.write(response.body)
+          file.rewind
+          return file
+        end
+      end
+      response
+    end
+  end
+
+  def resource_name
+    self.class.name.split("::").last.underscore.pluralize.downcase
+  end
+
+  def self.resource_name
+    self.name.split("::").last.underscore.pluralize.downcase
+  end
+
+  def to_s
+    @json.inspect
+  end
+
+  protected
+
+  def get_resource(name, uri, params={})
+    execute_with_rescue do
+      force = params.delete(:ignore_cache)
+      if @cache[name] && @cache[name][:params] == params && force != true
+        @cache[name][:records]
+      else
+        @cache[name] = { :params => params }
+        if params == {} && @json[name]
+          records = []
+          @json[name].each do |record|
+            records << SifiApi.const_get(name.classify).new(record, @connection, @user_key)
+          end
+        else
+          records = SifiApi.const_get(name.classify).get_via_uri(@connection, @user_key, uri, params)
+        end
+        @cache[name][:records] = records
+      end
+    end
+  end
+
+  def execute_with_rescue(&block)
+    yield
+  rescue Exception => exception
+    rescue_with_handler(exception) || raise
+  end
+
+end

data/lib/sifi_api/user.rb

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

data/lib/sifi_api/version.rb

@@ -0,0 +1,9 @@
+module SifiApi
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    PATCH = 0
+    PRE   = nil
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

data/lib/sifi_api.rb

@@ -0,0 +1,41 @@
+require "rubygems"
+require "bundler/setup"
+require "faraday"
+require "multi_json"
+require "active_support/inflector"
+require "active_support/rescuable"
+require "sifi_api/error"
+
+module SifiApi
+  autoload :Ad, "sifi_api/ad"
+  autoload :AdFileType, "sifi_api/ad_file_type"
+  autoload :AdSize, "sifi_api/ad_size"
+  autoload :BidType, "sifi_api/bid_type"
+  autoload :BrandedDatum, "sifi_api/branded_datum"
+  autoload :Browser, "sifi_api/browser"
+  autoload :Campaign, "sifi_api/campaign"
+  autoload :CampaignStat, "sifi_api/campaign_stat"
+  autoload :CampaignType, "sifi_api/campaign_type"
+  autoload :Change, "sifi_api/change"
+  autoload :Client, "sifi_api/client"
+  autoload :Company, "sifi_api/company"
+  autoload :Connection, "sifi_api/connection"
+  autoload :Context, "sifi_api/context"
+  autoload :Dayparting, "sifi_api/dayparting"
+  autoload :Device, "sifi_api/device"
+  autoload :Dma, "sifi_api/dma"
+  autoload :Domain, "sifi_api/domain"
+  autoload :GeoTarget, "sifi_api/geo_target"
+  autoload :IpRange, "sifi_api/ip_range"
+  autoload :Keyword, "sifi_api/keyword"
+  autoload :KeywordCategory, "sifi_api/keyword_category"
+  autoload :OperatingSystem, "sifi_api/operating_system"
+  autoload :Recency, "sifi_api/recency"
+  autoload :RecurringReport, "sifi_api/recurring_report"
+  autoload :Report, "sifi_api/report"
+  autoload :ReportAsset, "sifi_api/report_asset"
+  autoload :ReportType, "sifi_api/report_type"
+  autoload :Resource, "sifi_api/resource"
+  autoload :User, "sifi_api/user"
+  autoload :VERSION, "sifi_api/version"
+end

data/lib/sifiapi.rb

@@ -0,0 +1 @@
+require 'sifi_api'

data/sifiapi.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sifi_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brandon Aaron"]
+  gem.email         = ["brandon@simpli.fi"]
+  gem.description   = ""
+  gem.summary       = "Ruby wrapper for the Simpli.fi API"
+  gem.homepage      = "http://simpli.fi"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sifiapi"
+  gem.require_paths = ["lib"]
+  gem.version = SifiApi::VERSION::STRING
+
+  gem.add_dependency 'faraday', '~> 0.7.6'
+  gem.add_dependency 'multi_json', '~> 1.0.3'
+  gem.add_dependency 'activesupport', '~> 3.0.10'
+  gem.add_dependency 'i18n', '~> 0.5.0'
+end

data/spec/sifi_api/ad_file_type_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::AdFileType do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::AdFileType
+
+end

data/spec/sifi_api/ad_size_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::AdSize do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::AdSize
+
+end

data/spec/sifi_api/ad_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Ad do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Ad
+
+end

data/spec/sifi_api/bid_type_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::BidType do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::BidType
+
+end

data/spec/sifi_api/branded_datum_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::BrandedDatum do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::BrandedDatum
+
+end

data/spec/sifi_api/browser_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Browser do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Browser
+
+end

data/spec/sifi_api/campaign_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Campaign do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Campaign
+
+end

data/spec/sifi_api/campaign_stat_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::CampaignStat do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::CampaignStat
+
+end

data/spec/sifi_api/campaign_type_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::CampaignType do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::CampaignType
+
+end

data/spec/sifi_api/change_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Change do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Change
+
+end

data/spec/sifi_api/client_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Client do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Client
+
+end

data/spec/sifi_api/company_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Company do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Company
+
+end

data/spec/sifi_api/context_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Context do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Context
+
+end

data/spec/sifi_api/dayparting_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Dayparting do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Dayparting
+
+end

data/spec/sifi_api/device_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Device do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Device
+
+end

data/spec/sifi_api/dma_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Dma do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Dma
+
+end

data/spec/sifi_api/domain_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Domain do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Domain
+
+end

data/spec/sifi_api/geo_target_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::GeoTarget do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::GeoTarget
+
+end

data/spec/sifi_api/ip_range_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::IpRange do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::IpRange
+
+end
+

data/spec/sifi_api/keyword_category_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::KeywordCategory do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::KeywordCategory
+
+end

data/spec/sifi_api/keyword_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::Keyword do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Keyword
+
+end
+

data/spec/sifi_api/operating_system_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::OperatingSystem do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::OperatingSystem
+
+end
+

data/spec/sifi_api/recency_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::Recency do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Recency
+
+end

data/spec/sifi_api/recurring_report_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::RecurringReport do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::RecurringReport
+
+end
+

data/spec/sifi_api/report_asset_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::ReportAsset do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::ReportAsset
+
+end
+

data/spec/sifi_api/report_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::Report do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::Report
+
+end
+

data/spec/sifi_api/report_type_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SifiApi::ReportType do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::ReportType
+
+end
+

data/spec/sifi_api/user_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SifiApi::User do
+
+  it_should_behave_like "SifiApi::Resource", SifiApi::User
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'sifi_api'
+
+require 'support/resource_shared_example'
+
+RSpec.configure do |config|
+
+  def connection
+    SifiApi::Connection.new("app_key")
+  end
+
+  def fake_resource
+    {
+      "resource" => "https://app.simpli.fi/api/fake_resources/1",
+      "id" => 1,
+      "name" => "Fake Resource 1",
+      "actions" => [
+        { "do_something" => { "method" => "GET", "href" => "https://app.simpli.fi/api/fake_resources/1/do_something" } }
+      ],
+      "resources" => [
+        { "fake_resources" => "https://app.simpli.fi/api/fake_resources/1/fake_resources" }
+      ]
+    }
+  end
+
+end

data/spec/support/resource_shared_example.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+class SifiApi::FakeResource < SifiApi::Resource
+end
+
+shared_examples_for 'SifiApi::Resource' do |resource|
+  before(:all) do
+    @connection = connection
+    @user_key = "user_key"
+    @resource = resource.new(fake_resource, @connection, @user_key)
+  end
+
+  it "should expose the raw json" do
+    @resource.raw_json.should == fake_resource
+  end
+
+  it "should expose properties of the json as methods of the class" do
+    @resource.name.should == fake_resource["name"]
+  end
+
+  it "should support hash methods run directly against the raw json" do
+    @resource.keys.should == fake_resource.keys
+  end
+
+  it "should call action if method is an action" do
+    action = fake_resource["actions"].first["do_something"]
+    begin
+      @connection.should_receive(action["method"].downcase.to_sym).with(@user_key, action["href"])
+    rescue SifiApi::NotFound => e
+    end
+    @resource.do_something
+  end
+
+  it "should load the resource if the method is a resource" do
+    resource = fake_resource["resources"].first
+    begin
+      @connection.should_receive(:get).with(@user_key, resource["fake_resources"], {})
+    rescue SifiApi::NotFound => e
+    end
+    @resource.fake_resources
+  end
+
+  it "should pass along params passed to a resource method call" do
+    resource = fake_resource["resources"].first
+    params = { :include => "testing" }
+    begin
+      @connection.should_receive(:get).with(@user_key, resource["fake_resources"], params)
+    rescue SifiApi::NotFound => e
+    end
+    @resource.fake_resources(params)
+  end
+
+  it "should not pass along the 'ignore_cache' param to a resource method call" do
+    resource = fake_resource["resources"].first
+    params = { :include => "testing" }
+    begin
+      @connection.should_receive(:get).with(@user_key, resource["fake_resources"], params)
+    rescue SifiApi::NotFound => e
+    end
+    @resource.fake_resources(params.merge!(:ignore_cache => true))
+  end
+
+  it "should provide a method to update the resource" do
+    params = { :name => "Plain Resource" }
+    begin
+      @connection.should_receive(:put).with(@user_key, fake_resource["resource"], { @resource.resource_name.singularize => params})
+    rescue SifiApi::NotFound => e
+    end
+    @resource.update(params)
+  end
+
+  it "should provide a method to create a nested resource" do
+    params = { :name => "Nested Resource" }
+    begin
+      @connection.should_receive(:post).with(@user_key, "#{fake_resource["resource"]}/fake_resources", { "fake_resource" => params})
+    rescue SifiApi::NotFound => e
+    end
+    @resource.create("fake_resource", params)
+  end
+
+  it "should provide a method to delete a resource" do
+    begin
+      @connection.should_receive(:delete).with(@user_key, fake_resource["resource"])
+    rescue SifiApi::NotFound => e
+    end
+    @resource.delete
+  end
+
+  it "should provide a method to reload a resource" do
+    begin
+      @connection.should_receive(:get).with(@user_key, fake_resource["resource"], {})
+    rescue SifiApi::NotFound => e
+    end
+    @resource.reload
+  end
+
+end