yahoo_gemini_client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 769db0035a436bc993c65ab58afc37887e805e81
-  data.tar.gz: 1f53ca079d78a3d734fd7a876d3644620afef740
+  metadata.gz: e70191d23f647d30b8dd3c8d0db05e16c0e31d6a
+  data.tar.gz: 4271d2ca037dbefdff853c43b637b85caed2b176
 SHA512:
-  metadata.gz: 2f3225a7ac8057a2a300dc5c949f6a3c544826aa053bc26a34af6d786f11f0d9545ad442e6bcfdbb9723485581e637029e775adfeadb2405fa7838e401dc5b2f
-  data.tar.gz: f8976c73c408d42d04d7f0439e59d22c029898d620f1113fb3e7046e3851e3b472b8a3f1100819690f7a4b4d7c05a7a4e361cd173373fadb615e5af0cad1c45c
+  metadata.gz: 12eb812b069bd68667eec7b481735296d52e8853000f790b5893682e20467d5b3277d661af018c90a8adc51f7893e42c495fa008077bb64735bbdc6566196eb8
+  data.tar.gz: 918cfbc4cc8f78ebd782cf1a3f2f65ec2dc4b592c01ec434a50dc8e63adfb894b4e7c968f4127a720007ac1d34ee42cb5e1cd6014559b93bb6219d84643485c6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.1.0
+
+- Add custom reports
+- Refactor advertisers
+
 # 0.0.1
 
 - Initial release

data/README.md

@@ -19,27 +19,42 @@ Or install it yourself as:
     $ gem install yahoo_gemini_client
 
 ## Usage
+Currently supports OAuth2 Auth Code Strategy (Explicit Grant Flow) only.
+For more info see https://developer.yahoo.com/oauth2/guide/flows_authcode/
 
-```ruby
-# Currently supports OAuth2 Auth Code Strategy (Explicit Grant Flow) only
-# see https://developer.yahoo.com/oauth2/guide/flows_authcode/
+### Getting a refresh token
+
+Your app can start using this gem if you have a refresh token.
+A refresh token can be manually generated through the console.
 
+```ruby
 client = YahooGeminiClient::Client.new(
-  client_id: "consumer_key",
-  client_secret: "consumer_secret",
-  refresh_token: "refresh_token"
+  consumer_key: "consumer_key",
+  consumer_secret: "consumer_secret",
 )
 
-client.authorization_url # returns authorization url
+# open a browser and go to the authorization url given to get the authorization code
+authorization_url = client.authorization_url
 
-# visit authorization url returned in a web browser to get the Authorization Code
-# assuming you've got an authentication code...
+# you can now generate the refresh token once you have the authorization code
+refresh_token = client.get_token("the_authorization_code").refresh_token
 
-client.get_token(authorization_code)
+# with the refresh token you can now instantiate and use a YahooGeminiClient::Client anytime
+client = YahooGeminiClient::Client.new(
+  consumer_key: "consumer_key",
+  consumer_secret: "consumer_secret",
+  refresh_token: refresh_token,
+)
+```
+
+### Advertisers
 
-# Advertisers endpoint
-client.advertisers.each { |advertiser| puts advertiser.advertiser_name }
-client.advertisers.find(123)
+#### Retrieving
+
+```ruby
+  response = client.advertisers.find(123)
+  response.error? # check if response is error
+  response.advertiser # returns a YahooGeminiClient::Advertiser
 ```
 
 ### Custom Reports
@@ -78,6 +93,22 @@ client.advertisers.find(123)
   response.csv_url # get the csv url of the created report
 ```
 
+### Campaigns
+
+#### Fetching campaigns for an advertiser
+
+```ruby
+  params = {advertiser_id: 12345}
+  response = client.campaigns.where(params)
+  response.campaigns # returns Array[YahooGeminiClient::Campaign]
+```
+
+## Creating a Test Yahoo Gemini Account (For Testing)
+
+1. Sign in using any given Yahoo Mail Account and go to `https://gemini.yahoo.com/advertiser/home`
+2. Press "Sign Up" to create a Yahoo Gemini Account.
+3. From here, you can create an advertiser and corresponding campaigns
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/yahoo_gemini_client.rb

@@ -5,15 +5,28 @@ require "active_support/core_ext/hash/indifferent_access"
 require "yahoo_gemini_client/version"
 require "yahoo_gemini_client/client"
 require "yahoo_gemini_client/generate_member_uri"
-require "yahoo_gemini_client/collection"
-require "yahoo_gemini_client/advertisers"
-require "yahoo_gemini_client/advertiser"
+require "yahoo_gemini_client/models/campaign"
+require "yahoo_gemini_client/services/campaigns"
 require "yahoo_gemini_client/services/custom_report"
+require "yahoo_gemini_client/models/advertiser"
+require "yahoo_gemini_client/services/advertisers"
+require "yahoo_gemini_client/models/ad_group"
+require "yahoo_gemini_client/services/ad_groups"
 require "yahoo_gemini_client/responses/base_response"
+require "yahoo_gemini_client/responses/advertiser_response"
 require "yahoo_gemini_client/requests/base_request"
+require "yahoo_gemini_client/requests/custom_report_base_request"
 require "yahoo_gemini_client/requests/custom_report_job_request"
 require "yahoo_gemini_client/requests/custom_report_check_job_request"
+require "yahoo_gemini_client/requests/campaign_base_request"
+require "yahoo_gemini_client/requests/campaign_fetch_request"
+require "yahoo_gemini_client/requests/advertiser_base_request"
+require "yahoo_gemini_client/requests/advertiser_fetch_request"
+require "yahoo_gemini_client/requests/ad_group_base_request"
+require "yahoo_gemini_client/requests/ad_group_fetch_request"
 require "yahoo_gemini_client/responses/custom_report_response"
+require "yahoo_gemini_client/responses/campaign_response"
+require "yahoo_gemini_client/responses/ad_group_response"
 
 module YahooGeminiClient
 

data/lib/yahoo_gemini_client/client.rb

@@ -12,13 +12,13 @@ module YahooGeminiClient
     def initialize(options={})
       @consumer_key = options[:consumer_key]
       @consumer_secret = options[:consumer_secret]
-      @refresh_token = options[:refresh_token]
       @oauth2_client ||= OAuth2::Client.new(consumer_key, consumer_secret, {
         :site => 'https://api.login.yahoo.com',
         :authorize_url => '/oauth2/request_auth',
         :token_url => '/oauth2/get_token',
       })
-      if options[:token]
+      if token_hash = options[:token]
+        @refresh_token = token_hash[:refresh_token]
         @token = OAuth2::AccessToken.from_hash(
           @oauth2_client,
           options[:token]
@@ -68,15 +68,24 @@ module YahooGeminiClient
       Advertisers.new(client: self)
     end
 
+    def campaigns
+      Campaigns.new(client: self)
+    end
+
+    def custom_report
+      CustomReport.new(client: self)
+    end
+
     def token_refresh!
+      # TODO: handle when there's no token
       self.token = self.token.refresh!({
         :redirect_uri => 'oob',
         :headers => oauth2_headers
       })
     end
 
-    def custom_report
-      CustomReport.new(client: self)
+    def ad_groups
+      AdGroups.new(client: self)
     end
 
   end

data/lib/yahoo_gemini_client/models/ad_group.rb

@@ -0,0 +1,38 @@
+module YahooGeminiClient
+  class AdGroup
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def id
+      @hash["id"]
+    end
+
+    def bid_set
+      # TODO wrap into array of Bid objects
+      @hash["bidSet"]
+    end
+
+    def advertiser_id
+      @hash["advertiserId"]
+    end
+
+    def ad_group_name
+      @hash["adGroupName"]
+    end
+
+    def campaign_id
+      @hash["campaignId"]
+    end
+
+    def start_date_str
+      @hash["startDateStr"]
+    end
+    def end_date_str
+      @hash["endDateStr"]
+    end
+
+  end
+end
+

data/lib/yahoo_gemini_client/models/campaign.rb

@@ -0,0 +1,67 @@
+module YahooGeminiClient
+  class Campaign
+
+    def initialize(campaign_hash)
+      @hash = campaign_hash.map do |key,value|
+        {key.to_s.camelize(:lower) => value}
+      end.reduce(:merge)
+    end
+
+    def id
+      @hash["id"]
+    end
+
+    def status
+      @hash["status"]
+    end
+
+    def name
+      @hash["campaignName"]
+    end
+
+    def budget
+      @hash["budget"]
+    end
+
+    def language
+      @hash["language"]
+    end
+
+    def budget_type
+      @hash["budgetType"]
+    end
+
+    def advertiser_id
+      @hash["advertiserId"]
+    end
+
+    def channel
+      @hash["channel"]
+    end
+
+    def objective
+      @hash["objective"]
+    end
+
+    def is_partner_network
+      @hash["isPartnerNetwork"]
+    end
+
+    def default_landing_url
+      @hash["defaultLandingUrl"]
+    end
+
+    def tracking_partner
+      @hash["trackingPartner"]
+    end
+
+    def app_locale
+      @hash["appLocale"]
+    end
+
+    def to_params_hash
+      @hash
+    end
+
+  end
+end

data/lib/yahoo_gemini_client/requests/ad_group_base_request.rb

@@ -0,0 +1,25 @@
+module YahooGeminiClient
+  class AdGroupBaseRequest < BaseRequest
+    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/adgroup"
+    include Virtus.model
+
+    def http_authorization_header
+      {"Authorization" => "Bearer #{access_token}"}
+    end
+
+    protected
+
+    def post(opts)
+      HTTParty.post(REQUEST_URI,
+        headers: http_request_header.merge(http_authorization_header),
+        body: request_body.to_json,
+      )
+    end
+
+    def get(opts)
+      HTTParty.get(opts[:request_uri],
+        headers: http_request_header.merge(http_authorization_header),
+      )
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/ad_group_fetch_request.rb

@@ -0,0 +1,21 @@
+module YahooGeminiClient
+  class AdGroupFetchRequest < AdGroupBaseRequest
+
+    attribute :ad_group_id, String
+
+    def execute
+      response = get(request_uri: build_request_uri)
+      AdGroupResponse.new(response.with_indifferent_access)
+    end
+
+    private
+
+    def build_request_uri
+      REQUEST_URI + ad_group_id_http_parameter
+    end
+
+    def ad_group_id_http_parameter
+      "/#{ad_group_id}"
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/advertiser_base_request.rb

@@ -0,0 +1,25 @@
+module YahooGeminiClient
+  class AdvertiserBaseRequest < BaseRequest
+    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/advertiser"
+    include Virtus.model
+
+    def http_authorization_header
+      {"Authorization" => "Bearer #{access_token}"}
+    end
+
+    protected
+
+    def post(opts)
+      HTTParty.post(REQUEST_URI,
+        headers: http_request_header.merge(http_authorization_header),
+        body: request_body.to_json,
+      )
+    end
+
+    def get(opts)
+      HTTParty.get(opts[:request_uri],
+        headers: http_request_header.merge(http_authorization_header),
+      )
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/advertiser_fetch_request.rb

@@ -0,0 +1,21 @@
+module YahooGeminiClient
+  class AdvertiserFetchRequest < AdvertiserBaseRequest
+
+    attribute :advertiser_id, String
+
+    def execute
+      response = get(request_uri: build_request_uri)
+      AdvertiserResponse.new(response.with_indifferent_access)
+    end
+
+    private
+
+    def build_request_uri
+      REQUEST_URI + advertiser_id_http_parameter
+    end
+
+    def advertiser_id_http_parameter
+      "/#{advertiser_id}"
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/base_request.rb

@@ -28,16 +28,6 @@ module YahooGeminiClient
       self.class.name.demodulize.gsub("Request", "").underscore.to_sym
     end
 
-    # def client
-    #   @client ||= Client.new(
-    #     consumer_key: ENV["YAHOO_GEMINI_TEST_CONSUMER_KEY"],
-    #     consumer_secret: ENV["YAHOO_GEMINI_TEST_CONSUMER_SECRET"],
-    #     token: {
-    #       refresh_token: ENV["YAHOO_GEMINI_TEST_REFRESH_TOKEN"],
-    #     }
-    #   )
-    # end
-
     protected
 
     def access_token

data/lib/yahoo_gemini_client/requests/campaign_base_request.rb

@@ -0,0 +1,25 @@
+module YahooGeminiClient
+  class CampaignBaseRequest < BaseRequest
+    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/campaign"
+    include Virtus.model
+
+    def http_authorization_header
+      {"Authorization" => "Bearer #{access_token}"}
+    end
+
+    protected
+
+    def post(opts)
+      HTTParty.post(REQUEST_URI,
+        headers: http_request_header.merge(http_authorization_header),
+        body: request_body.to_json,
+      )
+    end
+
+    def get(opts)
+      HTTParty.get(opts[:request_uri],
+        headers: http_request_header.merge(http_authorization_header),
+      )
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/campaign_fetch_request.rb

@@ -0,0 +1,21 @@
+module YahooGeminiClient
+  class CampaignFetchRequest < CampaignBaseRequest
+
+    attribute :advertiser_id, String
+
+    def execute
+      response = get(request_uri: build_request_uri)
+      CampaignResponse.new(response.with_indifferent_access)
+    end
+
+    private
+
+    def build_request_uri
+      REQUEST_URI + advertiser_id_http_parameter
+    end
+
+    def advertiser_id_http_parameter
+      "?advertiserId=#{advertiser_id}"
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/custom_report_base_request.rb

@@ -0,0 +1,25 @@
+module YahooGeminiClient
+  class CustomReportBaseRequest < BaseRequest
+    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/reports/custom"
+    include Virtus.model
+
+    def http_authorization_header
+      {"Authorization" => "Bearer #{access_token}"}
+    end
+
+    protected
+
+    def post(opts)
+      HTTParty.post(REQUEST_URI,
+        headers: http_request_header.merge(http_authorization_header),
+        body: request_body.to_json,
+      )
+    end
+
+    def get(opts)
+      HTTParty.get(opts[:request_uri],
+        headers: http_request_header.merge(http_authorization_header),
+      )
+    end
+  end
+end

data/lib/yahoo_gemini_client/requests/custom_report_check_job_request.rb

@@ -1,23 +1,21 @@
 module YahooGeminiClient
-  class CustomReportCheckJobRequest < BaseRequest
-    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/reports/custom/"
-
-    attribute :request_body, String
+  class CustomReportCheckJobRequest < CustomReportBaseRequest
     attribute :advertiser_id, String
     attribute :job_id, String
 
     def execute
-      http_authorization_header = {"Authorization" => "Bearer #{access_token}"}
-      response = HTTParty.get(build_request_uri,
-        headers: http_request_header.merge(http_authorization_header),
-      )
+      response = get(request_uri: build_request_uri)
       CustomReportResponse.new(response.with_indifferent_access)
     end
 
     private
 
     def build_request_uri
-      REQUEST_URI + job_id + advertiser_id_http_parameter
+      REQUEST_URI + job_id_http_parameter + advertiser_id_http_parameter
+    end
+
+    def job_id_http_parameter
+      "/#{job_id}"
     end
 
     def advertiser_id_http_parameter

data/lib/yahoo_gemini_client/requests/custom_report_job_request.rb

@@ -1,15 +1,12 @@
 module YahooGeminiClient
-  class CustomReportJobRequest < BaseRequest
-    REQUEST_URI = "https://api.admanager.yahoo.com/v1/rest/reports/custom"
-
+  class CustomReportJobRequest < CustomReportBaseRequest
     attribute :request_body
 
     def execute
-      http_authorization_header = {"Authorization" => "Bearer #{access_token}"}
-      response = HTTParty.post(REQUEST_URI,
-        headers: http_request_header.merge(http_authorization_header),
-        body: request_body.to_json,
-      )
+      response = post({
+        request_uri: REQUEST_URI,
+        request_body: request_body.to_json
+      })
       CustomReportResponse.new(response.with_indifferent_access)
     end
   end

data/lib/yahoo_gemini_client/responses/ad_group_response.rb

@@ -0,0 +1,11 @@
+module YahooGeminiClient
+  class AdGroupResponse < BaseResponse
+    attr_accessor :errors, :timestamp, :ad_group
+
+    def initialize(json_response)
+      @errors = json_response[:errors]
+      @timestamp = json_response[:timestamp]
+      @ad_group = AdGroup.new(json_response[:response])
+    end
+  end
+end

data/lib/yahoo_gemini_client/responses/advertiser_response.rb

@@ -0,0 +1,11 @@
+module YahooGeminiClient
+  class AdvertiserResponse < BaseResponse
+    attr_accessor :errors, :timestamp, :advertiser
+
+    def initialize(json_response)
+      @errors = json_response[:errors]
+      @timestamp = json_response[:timestamp]
+      @advertiser = Advertiser.new(json_response[:response])
+    end
+  end
+end

data/lib/yahoo_gemini_client/responses/base_response.rb

@@ -1,5 +1,7 @@
 module YahooGeminiClient
   class BaseResponse
-
+    def error?
+      !@errors.nil?
+    end
   end
 end

data/lib/yahoo_gemini_client/responses/campaign_response.rb

@@ -0,0 +1,22 @@
+module YahooGeminiClient
+  class CampaignResponse < BaseResponse
+    attr_accessor :errors, :timestamp, :campaigns
+
+    def initialize(json_response)
+      @errors = json_response[:errors]
+      @timestamp = json_response[:timestamp]
+      @campaigns = []
+      if json_response[:response]
+        build_campaigns(json_response[:response])
+      end
+    end
+
+    private
+
+    def build_campaigns(campaigns_hashes)
+      @campaigns = campaigns_hashes.map do |campaign_hash|
+        Campaign.new(campaign_hash)
+      end
+    end
+  end
+end

data/lib/yahoo_gemini_client/responses/custom_report_response.rb

@@ -1,5 +1,5 @@
 module YahooGeminiClient
-  class CustomReportResponse
+  class CustomReportResponse < BaseResponse
     attr_accessor :errors, :timestamp, :job_id, :status, :csv_url
 
     def initialize(json_response)
@@ -12,10 +12,6 @@ module YahooGeminiClient
       end
     end
 
-    def error?
-      !@errors.nil?
-    end
-
     def completed?
       @status == "completed"
     end

data/lib/yahoo_gemini_client/services/ad_groups.rb

@@ -0,0 +1,12 @@
+module YahooGeminiClient
+  class AdGroups
+    def initialize(opts={})
+      @client = opts[:client]
+    end
+
+    def find(ad_group_id)
+      params = { ad_group_id: ad_group_id }
+      AdGroupFetchRequest.new(params.merge(client: @client)).execute
+    end
+  end
+end

data/lib/yahoo_gemini_client/services/advertisers.rb

@@ -0,0 +1,12 @@
+module YahooGeminiClient
+  class Advertisers
+    def initialize(opts={})
+      @client = opts[:client]
+    end
+
+    def find(advertiser_id)
+      params = { advertiser_id: advertiser_id }
+      AdvertiserFetchRequest.new(params.merge(client: @client)).execute
+    end
+  end
+end

data/lib/yahoo_gemini_client/services/campaigns.rb

@@ -0,0 +1,11 @@
+module YahooGeminiClient
+  class Campaigns
+    def initialize(opts={})
+      @client = opts[:client]
+    end
+
+    def where(params)
+      CampaignFetchRequest.new(params.merge(client: @client)).execute
+    end
+  end
+end

data/lib/yahoo_gemini_client/version.rb

@@ -1,3 +1,3 @@
 module YahooGeminiClient
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_gemini_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ramon Tayag
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -230,16 +230,29 @@ files:
 - bin/console
 - bin/setup
 - lib/yahoo_gemini_client.rb
-- lib/yahoo_gemini_client/advertiser.rb
-- lib/yahoo_gemini_client/advertisers.rb
 - lib/yahoo_gemini_client/client.rb
-- lib/yahoo_gemini_client/collection.rb
 - lib/yahoo_gemini_client/generate_member_uri.rb
+- lib/yahoo_gemini_client/models/ad_group.rb
+- lib/yahoo_gemini_client/models/advertiser.rb
+- lib/yahoo_gemini_client/models/campaign.rb
+- lib/yahoo_gemini_client/requests/ad_group_base_request.rb
+- lib/yahoo_gemini_client/requests/ad_group_fetch_request.rb
+- lib/yahoo_gemini_client/requests/advertiser_base_request.rb
+- lib/yahoo_gemini_client/requests/advertiser_fetch_request.rb
 - lib/yahoo_gemini_client/requests/base_request.rb
+- lib/yahoo_gemini_client/requests/campaign_base_request.rb
+- lib/yahoo_gemini_client/requests/campaign_fetch_request.rb
+- lib/yahoo_gemini_client/requests/custom_report_base_request.rb
 - lib/yahoo_gemini_client/requests/custom_report_check_job_request.rb
 - lib/yahoo_gemini_client/requests/custom_report_job_request.rb
+- lib/yahoo_gemini_client/responses/ad_group_response.rb
+- lib/yahoo_gemini_client/responses/advertiser_response.rb
 - lib/yahoo_gemini_client/responses/base_response.rb
+- lib/yahoo_gemini_client/responses/campaign_response.rb
 - lib/yahoo_gemini_client/responses/custom_report_response.rb
+- lib/yahoo_gemini_client/services/ad_groups.rb
+- lib/yahoo_gemini_client/services/advertisers.rb
+- lib/yahoo_gemini_client/services/campaigns.rb
 - lib/yahoo_gemini_client/services/custom_report.rb
 - lib/yahoo_gemini_client/version.rb
 - yahoo_gemini_client.gemspec

data/lib/yahoo_gemini_client/advertisers.rb

@@ -1,22 +0,0 @@
-module YahooGeminiClient
-  class Advertisers < Collection
-
-    def all
-      response = get(base_uri)
-      response.map do |advertiser_hash|
-        Advertiser.new(advertiser_hash)
-      end
-    end
-
-    def find(ids)
-      uri = GenerateMemberURI.execute(base_uri, ids)
-      response = get(uri.to_s)
-      response.map { |advertiser_hash| Advertiser.new(advertiser_hash) }
-    end
-
-    def base_uri
-      'https://api.admanager.yahoo.com/v1/rest/advertiser/'
-    end
-
-  end
-end

data/lib/yahoo_gemini_client/collection.rb

@@ -1,41 +0,0 @@
-module YahooGeminiClient
-  class Collection
-
-    attr_reader :client
-    include Enumerable
-
-    def initialize(opts={})
-      @client = opts[:client]
-    end
-
-    def api_request_headers
-      client.api_request_headers
-    end
-
-    def each
-      @members ||= all
-      @members.each { |member| yield member }
-    end
-
-    private
-
-    def get(uri)
-      response = HTTParty.get(uri, headers: api_request_headers)
-      if response.success?
-        JSON.parse(response.body).with_indifferent_access[:response]
-      else
-        # TODO testme
-        raise "Reponse Unsuccessful: #{response.body}"
-      end
-    end
-
-    def member_uri(ids)
-      GenerateMemberURI.execute(ids)
-    end
-
-    def base_uri
-      raise 'This must be overriden'
-    end
-
-  end
-end