outbrain-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f66b5ef4e32101b544427473855635ee498d3e4
-  data.tar.gz: 0e894ebfe8a7655a7827b590f3f8e7f779996f74
+  metadata.gz: c989cd84656d8f8bb53a3cf81091017746affd6a
+  data.tar.gz: 70494a86c706a0c49d2e357de5b23b04c4d4d331
 SHA512:
-  metadata.gz: 2d84897df03ae6cc597a4ed2f21ebd05ff14e2b0cbdb4295d4cab8740dcbd4c790c17a2da618d67b403405dac50f087c8ded3794f619dea34632edb2d9c45a9e
-  data.tar.gz: 64035b9c6963f5d0b0411da87a79216a6cdbf8b552d33ec95d3e4905d371323ae82899316b4874230dd892784ef65d3d0a7c458ab30d1402285e2acaf95eb154
+  metadata.gz: 213c1a88c77290236f758ef2a699fccd4e17f5de66089e8a28670c34648fbc451099f6d824514ccee9054354a05c3b70b44cb6c4e14d52c015125b37e458e808
+  data.tar.gz: e7d72ffcccff1b7ea7dfdf6a2bfb7df746722629dceed2d1b067445b3a8484a70b47b963312dcbac4d8b97de43bdf0a2e396b472104ef6ea0baf05b4447fda4f

data/lib/outbrain/api.rb

@@ -1,56 +1,18 @@
 require "outbrain/api/version"
-require 'faraday'
-require 'json'
+
+# configs
+require "outbrain/connection"
+require "outbrain/config"
+require "outbrain/base"
+require "outbrain/request"
+
+# models
+require "outbrain/api/marketer"
+require "outbrain/api/campaign"
 
 module Outbrain
   HEADER_AUTH_KEY = 'OB-TOKEN-V1'
 
   module Api
   end
-
-  class Connection
-    attr_accessor :token, :user_name, :user_password, :connection, :api_version, :logging
-
-    def initialize(args={})
-      @token = args[:token] || args['token']
-      @user_name = args[:user_name] || args['user_name']
-      @user_password = args[:user_password] || args['user_password']
-      @api_version = args[:api_version] || args['api_version'] || 'v0.1'
-      @logging = args[:logging] || args['logging'] || true # (default right now)
-
-      get_token! unless @token
-      # should raise if not authenticated properly
-    end
-
-    # authenticates using basic auth to get token.
-    # => http://docs.amplifyv01.apiary.io/#reference/authentications
-    def get_token!
-      @temp_connection = Faraday.new(:url => "https://api.outbrain.com") do |faraday|
-        faraday.response :logger if logging
-        faraday.adapter  Faraday.default_adapter
-      end
-
-      @temp_connection.basic_auth user_name, user_password
-      response = @temp_connection.get("/amplify/#{api_version}/login")
-      @token = JSON.parse(response.body)[HEADER_AUTH_KEY]
-      # need to raise error here if token does not exist
-    end
-
-    def connection
-      @connection ||= refresh_connection
-    end
-
-    def refresh_connection
-      @connection = Faraday.new(:url => "https://api.outbrain.com") do |faraday|
-        faraday.response :logger if @logging
-        faraday.adapter  Faraday.default_adapter
-        faraday.headers['Content-Type'] = 'application/json'
-        faraday.headers[HEADER_AUTH_KEY] = token
-      end
-    end
-
-    def marketers
-      connection.get("/amplify/#{api_version}/marketers")
-    end
-  end
 end

data/lib/outbrain/api/budget.rb

@@ -0,0 +1,20 @@
+module Outbrain
+  module Api
+    class Budget < Base
+
+      def self.path(id)
+        "/marketers/#{id}/budgets"
+      end
+
+      def self.find_by(attributes={})
+        marketer_id = attributes[:marketer_id]
+        fail InvalidOption 'find_by requires marketer-id' unless marketer_id
+        Request.all(path(marketer_id), { as: self, resource_name: 'budgets'})
+      end
+
+      def create_campaign(attributes)
+        Campaign.create(attributes.merge(budgetId: id))
+      end
+    end
+  end
+end

data/lib/outbrain/api/campaign.rb

@@ -0,0 +1,11 @@
+module Outbrain
+  module Api
+    class Campaign < Base
+      PATH = 'campaigns'
+
+      def self.create(attributes)
+        Request.create(PATH, { as: self, attributes: attributes })
+      end
+    end
+  end
+end

data/lib/outbrain/api/errors.rb

@@ -0,0 +1,5 @@
+module Outbrain
+  module Api
+    class EndpointNotAvialable < NoMethodError; end
+  end
+end

data/lib/outbrain/api/marketer.rb

@@ -0,0 +1,24 @@
+require "outbrain/api/publisher"
+require "outbrain/api/budget"
+
+module Outbrain
+  module Api
+    class Marketer < Base
+      coerce_key :blockedPublishers, Array[Publisher]
+
+      PATH = 'marketers'
+
+      def self.all
+        Request.all(PATH, { as: self })
+      end
+
+      def self.create(*)
+        raise EndpointNotAvialable.new('Marketers can not be created via the api.')
+      end
+
+      def budgets
+        Budget.find_by(marketer_id: id)
+      end
+    end
+  end
+end

data/lib/outbrain/api/publisher.rb

@@ -0,0 +1,5 @@
+module Outbrain
+  module Api
+    class Publisher < Base ; end
+  end
+end

data/lib/outbrain/api/version.rb

@@ -1,5 +1,5 @@
 module Outbrain
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/outbrain/base.rb

@@ -0,0 +1,28 @@
+require 'hashie'
+
+# remaking some of active-model here :-( but don't want rails
+
+module Outbrain
+  class Base < Hash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::Coercion
+
+    attr_accessor :errors
+
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end
+      @errors = attributes.fetch(:errors, [])
+      self
+    end
+
+    def valid?
+      errors.emtpy?
+    end
+
+    def persisted?
+      try(:id).present?
+    end
+  end
+end

data/lib/outbrain/config.rb

@@ -0,0 +1,33 @@
+module Outbrain
+  class Config
+    BASE = Outbrain::Connection::BASE
+
+    @@api = nil
+    @@api_version = nil
+
+    def self.api=(api)
+      @@api = api
+    end
+
+    def self.api_version=(api_version)
+      @@api_version = api_version
+    end
+
+    private
+    def self.api
+      @@api
+    end
+
+    def api
+      self.class.api
+    end
+
+    def api_version
+      self.class.api_version
+    end
+
+    def self.api_version
+      @@api_version
+    end
+  end
+end

data/lib/outbrain/connection.rb

@@ -0,0 +1,55 @@
+require 'faraday'
+require 'json'
+
+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
+
+    def initialize(args={})
+      @token = args[:token] || args['token']
+      @user_name = args[:user_name] || args['user_name']
+      @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)
+
+      get_token! unless @token
+      # should raise if not authenticated properly
+    end
+
+    def self.configure(params={})
+      connection = new(params)
+      Config.api = connection.api
+      Config.api_version = connection.api_version
+      connection
+    end
+
+    # 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|
+        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")
+      @token = JSON.parse(response.body)[Outbrain::HEADER_AUTH_KEY]
+      # need to raise error here if token does not exist
+    end
+
+    def api
+      @api ||= refresh_api
+    end
+
+    def refresh_api
+      @api = Faraday.new(:url => BASE) do |faraday|
+        faraday.response :logger if logging
+        faraday.adapter  Faraday.default_adapter
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers[Outbrain::HEADER_AUTH_KEY] = token
+      end
+    end
+  end
+end

data/lib/outbrain/request.rb

@@ -0,0 +1,35 @@
+module Outbrain
+  class Request < Config
+
+    def self.where(resource_path, query={}, options={})
+      response = api.get("/amplify/#{api_version}/#{resource_path}")
+      resource_name = options.fetch(:resource_name, resource_path)
+      json_body = JSON.parse(response.body) # catch and raise proper api error
+
+      fail InvalidOption 'requires an as option' unless options[:as]
+
+      json_body[resource_name].map do |obj|
+        options[:as].new(obj)
+      end
+    end
+
+    def self.all(resource, options={})
+      where(resource, {}, options)
+    end
+
+    def self.create(resource, options={})
+      attributes = options.fetch(:attributes, {})
+
+      response = api.post("/amplify/#{api_version}/#{resource}", attributes.to_json)
+      json_body = JSON.parse(response.body)
+
+      if response.status == 200
+        options[:as].new(json_body)
+      else
+        a = options[:as].new
+        a.errors.push(json_body)
+        a
+      end
+    end
+  end
+end

data/outbrain-api.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency("faraday")
   spec.add_runtime_dependency("json")
+  spec.add_runtime_dependency("hashie")
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outbrain-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Blanchet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,17 @@ files:
 - bin/console
 - bin/setup
 - lib/outbrain/api.rb
+- lib/outbrain/api/budget.rb
+- lib/outbrain/api/campaign.rb
+- lib/outbrain/api/config.rb
+- lib/outbrain/api/errors.rb
+- lib/outbrain/api/marketer.rb
+- lib/outbrain/api/publisher.rb
 - lib/outbrain/api/version.rb
+- lib/outbrain/base.rb
+- lib/outbrain/config.rb
+- lib/outbrain/connection.rb
+- lib/outbrain/request.rb
 - outbrain-api.gemspec
 homepage: https://github.com/simplereach/outbrain-api
 licenses: