outbrain-api 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a156c1b833c40ae218e3ed8c982111ff5b79fbec
-  data.tar.gz: b4f0d95d8048b68ac9647ce3c88b47469fc992f8
+  metadata.gz: 611076af635dfef59515e4d7370424ae0924e924
+  data.tar.gz: 22e7cdfdce710aa25d8aaa97f1ccefdb353c84a2
 SHA512:
-  metadata.gz: e3a0ac6568a62ebf1af6fb00f7cb91f1dfc73ad1c10787e15928634eae0392ae5c323246adc9fdc2e0da35c633d748cac73f7123eb4843c0bc7ab35e6643bc40
-  data.tar.gz: 571521763074e1b9ffa294b027c96cc8b57472407b6147fdc67ada77238db181cc84fb19b51fd513582b70385d52333508ffafa489c6cd693d661cf5599eaf0b
+  metadata.gz: ab1b4431d4e0a92e15c31e1616891e1a466375317a8b3d8d6bdbe58b63255ed21f535e0d993fd9414412e437e296d9ffa25706e15a30ff3f87ca24f9b8a6d17f
+  data.tar.gz: 6b856617eeeb6c0fb438c18a0ab053f40d98743ab45ce5d3876d28618489df352f8946425606e1272209a12ef21dca586e094f822e4cf89860b98877058d5109

data/lib/outbrain/api.rb

@@ -14,6 +14,8 @@ require "outbrain/api/budget"
 require "outbrain/api/campaign_report"
 require "outbrain/api/publisher_report"
 require "outbrain/api/campaign_by_day_report"
+require "outbrain/api/promoted_link_performance_report"
+require "outbrain/api/promoted_link"
 
 module Outbrain
   HEADER_AUTH_KEY = 'OB-TOKEN-V1'

data/lib/outbrain/api/campaign_by_day_report.rb

@@ -4,15 +4,9 @@ module Outbrain
   module Api
     class CampaignByDayReport < Report
       PATH = 'performanceByDay'
-
-      def self.path(campaign_id)
-        "campaigns/#{campaign_id}/#{PATH}"
-      end
-
-      def self.where(options = {})
-        super(options.merge({path: self.path(options.fetch(:campaign_id))}))
+      def self.path(options)
+        "campaigns/#{options.fetch(:campaign_id)}/#{PATH}/"
       end
     end
   end
 end
-

data/lib/outbrain/api/campaign_report.rb

@@ -4,13 +4,8 @@ module Outbrain
   module Api
     class CampaignReport < Report
       PATH = 'performanceByCampaign'
-
-      def self.path(marketer_id)
-        "marketers/#{marketer_id}/#{PATH}"
-      end
-
-      def self.where(options = {})
-        super(options.merge({path: self.path(options.fetch(:marketer_id))}))
+      def self.path(options)
+        "marketers/#{options.fetch(:marketer_id)}/#{PATH}/"
       end
     end
   end

data/lib/outbrain/api/promoted_link.rb

@@ -0,0 +1,19 @@
+require 'outbrain/api/report'
+
+module Outbrain
+  module Api
+    class PromotedLink < Base
+      PATH = "promotedLinks"
+      RESOURCE_NAME = PATH
+      
+      def self.find(id)
+          Request.find( PATH, id, { as: self })
+      end
+
+      def self.where(options)
+        path = "campaigns/#{options.fetch(:campaign_id)}/#{PATH}"
+        Request.where(path, options, as: self, resource_name: RESOURCE_NAME)
+      end
+    end
+  end
+end

data/lib/outbrain/api/promoted_link_performance_report.rb

@@ -0,0 +1,13 @@
+require 'outbrain/api/report'
+
+module Outbrain
+  module Api
+    class PromotedLinkPerformanceReport < Report
+      PATH = 'performanceByPromotedLink'
+
+      def self.path(options)
+        "campaigns/#{options.fetch(:campaign_id)}/#{PATH}/"
+      end
+    end
+  end
+end

data/lib/outbrain/api/publisher_report.rb

@@ -4,15 +4,9 @@ module Outbrain
   module Api
     class PublisherReport < Report
       PATH = 'performanceByPublisher'
-
-      def self.path(campaign_id)
-        "campaigns/#{campaign_id}/#{PATH}"
-      end
-
-      def self.where(options = {})
-        super(options.merge({path: self.path(options.fetch(:campaign_id))}))
+      def self.path(options)
+        "campaigns/#{options.fetch(:campaign_id)}/#{PATH}/"
       end
     end
   end
 end
-

data/lib/outbrain/api/relation.rb

@@ -1,20 +1,21 @@
 module Outbrain
   module Api
-    class Relation
+    class Relation < OpenStruct
       include Enumerable
-      attr_accessor :relations, :errors, :totalDataCount, :overAllMetrics, :aggregatedBy, :details, :overallMetrics
-
+      extend Forwardable
+      def_delegator :relations, :each, :each
       def initialize(options = {})
-        @relations = []
-        @errors = []
+        super
+        self.errors = []
+        relation = options.delete(options[:relation_name])
+        Hashie::Mash.new(options).each{ |k,v| self[k] = v }
+        setup_relations(relation)
       end
 
-      def each &block
-        @relations.each{|relation| block.call(relation) }
-      end
+      private
 
-      def any?
-        relations.any?
+      def setup_relations(relation)
+        self.relations = relation.map { |e| relation_class.new(e) }
       end
     end
   end

data/lib/outbrain/api/report.rb

@@ -1,13 +1,16 @@
 module Outbrain
   module Api
     class Report < Base
-      REPORT_PARAMETERS = [:from, :to, :limit, :offset, :sort]
-      RESOURCE_NAME = 'details'
+      def self.resource_name
+        'details'
+      end
 
       def self.where(options = {})
-        report_query = options.select{|option, v| REPORT_PARAMETERS.include?(option) && !v.nil?}        
-        report_options = { as: self, resource_name: RESOURCE_NAME, meta_resource_names: options.fetch(:meta_resource_names, []) }
-        Request.where(options.fetch(:path), report_query, report_options)
+        report_options = {
+          as: self,
+          resource_name: resource_name,
+        }
+        Request.where(self.path(options), options, report_options)
       end
     end
   end

data/lib/outbrain/api/version.rb

@@ -1,5 +1,5 @@
 module Outbrain
   module Api
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/outbrain/base.rb

@@ -24,5 +24,9 @@ module Outbrain
     def persisted?
       try(:id).present?
     end
+
+    def extract_query_options(options, query_keys)
+      options.partition{|option, v| query_keys.include?(option) && !v.nil?}
+    end
   end
 end

data/lib/outbrain/config.rb

@@ -1,7 +1,5 @@
 module Outbrain
   class Config
-    BASE = Outbrain::Connection::BASE
-
     @@api = nil
     @@api_version = nil
 

data/lib/outbrain/connection.rb

@@ -5,7 +5,7 @@ module Outbrain
   class Connection
     BASE = 'https://api.outbrain.com'
     DEFAULT_API_VERSION = 'v0.1'
-    attr_accessor :token, :user_name, :user_password, :connection, :api_version, :logging
+    attr_accessor :token, :user_name, :user_password, :connection, :api_version, :logging, :base_url
 
     def initialize(args={})
       @token = args[:token] || args['token']
@@ -13,7 +13,7 @@ module Outbrain
       @user_password = args[:user_password] || args['user_password']
       @api_version = args[:api_version] || args['api_version'] || DEFAULT_API_VERSION
       @logging = args[:logging] || args['logging'] || true # (default right now)
-
+      @base_url = args[:base_url] || "#{BASE}/amplify/#{api_version}/"
       get_token! unless @token
       # should raise if not authenticated properly
     end
@@ -28,13 +28,13 @@ module Outbrain
     # authenticates using basic auth to get token.
     # => http://docs.amplifyv01.apiary.io/#reference/authentications
     def get_token!
-      @temp_api = Faraday.new(:url => BASE) do |faraday|
+      @temp_api = Faraday.new(:url => base_url) do |faraday|
         faraday.response :logger if logging
         faraday.adapter  Faraday.default_adapter
       end
 
       @temp_api.basic_auth user_name, user_password
-      response = @temp_api.get("/amplify/#{api_version}/login")
+      response = @temp_api.get("/login")
       @token = JSON.parse(response.body)[Outbrain::HEADER_AUTH_KEY]
       # need to raise error here if token does not exist
     end
@@ -44,7 +44,7 @@ module Outbrain
     end
 
     def refresh_api
-      @api = Faraday.new(:url => BASE) do |faraday|
+      @api = Faraday.new(:url => base_url) do |faraday|
         faraday.response :logger if logging
         faraday.adapter  Faraday.default_adapter
         faraday.headers['Content-Type'] = 'application/json'

data/lib/outbrain/request.rb

@@ -1,25 +1,20 @@
 module Outbrain
   class Request < Config
     def self.where(resource_path, query={}, options={})
-      request_path = "/amplify/#{api_version}/#{resource_path}"
+      request_path = resource_path
       query_string = query.map{|k,v| "#{k}=#{v}"}.join("&")
       request_path = request_path + '?' + query_string unless query_string.empty?
       response = api.get(request_path)
       resource_name = options.fetch(:resource_name, resource_path)
-      meta_requests = options.fetch(:meta_resource_names)
       json_body = JSON.parse(response.body) # catch and raise proper api error
 
       fail InvalidOption 'requires an as option' unless options[:as]
 
       if response.status == 200
-        Outbrain::Api::Relation.new.tap do |r|
-          meta_requests.each{ |field| r.send("#{field}=", json_body[field]) }
-          r.relations = json_body[resource_name].map{ |obj| options[:as].new(obj) }
-        end
+        Outbrain::Api::Relation
+          .new(json_body.merge(relation_class: options[:as], relation_name: resource_name))
       else
-        Outbrain::Api::Relation.new.tap do |r|
-          r.errors << json_body
-        end
+        Outbrain::Api::Relation.new(errors: json_body)
       end
     end
 
@@ -28,7 +23,7 @@ module Outbrain
     end
 
     def self.find(resource_path, id, options={})
-      response = api.get("/amplify/#{api_version}/#{resource_path}/#{id}")
+      response = api.get("#{resource_path}/#{id}")
       json_body = JSON.parse(response.body)
 
       fail InvalidOption 'requires an as option' unless options[:as]
@@ -45,7 +40,7 @@ module Outbrain
     def self.create(resource, options={})
       attributes = options.fetch(:attributes, {})
 
-      response = api.post("/amplify/#{api_version}/#{resource}", attributes.to_json)
+      response = api.post("#{resource}", attributes.to_json)
       json_body = JSON.parse(response.body)
 
       if response.status == 200
@@ -59,7 +54,7 @@ module Outbrain
 
     def self.update(resource_path, id, options={})
       attributes = options.fetch(:attributes, {})
-      response = api.put("/amplify/#{api_version}/#{resource_path}/#{id}", attributes.to_json)
+      response = api.put("#{resource_path}/#{id}", attributes.to_json)
       json_body = JSON.parse(response.body)
 
       if response.status == 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outbrain-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nick Blanchet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -118,6 +118,8 @@ files:
 - lib/outbrain/api/config.rb
 - lib/outbrain/api/errors.rb
 - lib/outbrain/api/marketer.rb
+- lib/outbrain/api/promoted_link.rb
+- lib/outbrain/api/promoted_link_performance_report.rb
 - lib/outbrain/api/publisher.rb
 - lib/outbrain/api/publisher_report.rb
 - lib/outbrain/api/relation.rb