soapy_cake 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d84a9fa4e30d6c6fe16a0b8c4c9ad0f3a7fa5fdb
+  data.tar.gz: 271ad7e092f7c9ee8319b7fa73720bfcbc4c1dbc
+SHA512:
+  metadata.gz: b77069e1844a7c8ba88d5d84982b5a8b95cc81bb1301744e7ef509780a18f376d296fa1ec21021d591804976f8b1656d0b024bd01588def199bc96427457a375
+  data.tar.gz: 2b362c00e8ed251b12025ad67ee73a757e1f7739c376bd6d348cadbabb711ab177836cded26f47d5d906dd23e6ad18c94344d3395276c744c23ba1cf405f4567

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.env
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p451

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soapy_cake.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ad2games GmbH
+
+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,56 @@
+# SoapyCake
+
+Simple client library for [cake](http://getcake.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'soapy_cake'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soapy_cake
+
+## Usage Examples
+
+First we assume that you set the `CAKE_DOMAIN` and `CAKE_API_KEY`
+environment variables.
+
+Export all advertisers:
+
+```ruby
+SoapyCake::Client.export.advertisers(opts)
+```
+
+Get report for specific date range:
+
+```ruby
+SoapyCake::Client.reports.affiliate_summary(
+  start_date: Date.beginning_of_month,
+  end_date: Date.today
+)
+```
+
+If you are interested in how we map methods to api endpoints take a look
+at [api_versions.yml](/ad2games/soapy_cake/blob/master/api_versions.yml).
+
+## Contributing
+
+1. Fork it (https://github.com/ad2games/soapy_cake/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Actual Soapy Cakes
+
+If you are looking for actual soap cakes...
+
+![Soapy Cake](http://soapycakes.co/wp-content/uploads/2012/05/blogpics17-310x205.jpg)
+
+you should head to [soapycakes.co](http://soapycakes.co).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/api_versions.yml

@@ -0,0 +1,103 @@
+---
+:admin:
+  :add:
+    :advertiser_credit: 1
+    :creative: 1
+    :manual_credit: 1
+  :addedit:
+    :advertiser: 1
+    :advertiser_credit_limit: 1
+    :affiliate: 2
+    :apply_suppression_list_to_offer: 1
+    :campaign: 2
+    :caps: 1
+    :contact: 1
+    :creative: 1
+    :creative_files: 1
+    :exchange_rates: 1
+    :geo_targets: 1
+    :offer: 3
+    :offer_contract: 1
+    :suppresion_list: 1
+    :vertical: 1
+  :auth:
+    :login: 2
+  :doc:
+    :posting_doc: 1
+  :edit:
+    :buyer: 1
+  :export:
+    :advertisers: 5
+    :affiliate_referrals: 1
+    :affiliates: 5
+    :buyer_contracts: 1
+    :buyers: 1
+    :campaigns: 6
+    :creatives: 3
+    :offers: 5
+    :rules_targets: 3
+    :schedules: 1
+  :get:
+    :account_statuses: 1
+    :advertisers: 1
+    :affiliate_tags: 1
+    :affiliate_tiers: 1
+    :billing_cycles: 1
+    :cap_intervals: 1
+    :cap_types: 1
+    :countries: 1
+    :currencies: 1
+    :departments: 1
+    :exchange_rates: 1
+    :get_api_key: 1
+    :inactive_reasons: 1
+    :languages: 1
+    :offer_statuses: 1
+    :offer_types: 1
+    :payment_settings: 1
+    :payment_types: 1
+    :price_formats: 1
+    :roles: 1
+    :tracking_domains: 1
+    :verticals: 2
+  :reports:
+    :advertiser_summary: 2
+    :affiliate_summary: 2
+    :campaign_summary: 2
+    :creative_summary: 2
+    :caps: 3
+    :clicks: 7
+    :conversion_changes: 10
+    :conversions: 11
+    :daily_summary_export: 1
+    :leads_by_affiliate_export: 1
+    :leads_by_buyer: 4
+    :login_export: 1
+    :offer_summary: 2
+    :traffic_export: 1
+  :signup:
+    :advertiser: 1
+    :affiliate: 4
+    :get_media_types: 1
+    :get_price_formats: 1
+    :get_traffic_types: 1
+    :get_vertical_categories: 1
+  :track:
+    :accepted_dispositions: 1
+    :conversion_dispositions: 2
+    :decrypt_affiliate_link: 1
+    :mass_conversion_adjustment: 2
+    :mass_conversion_insert: 2
+    :rejected_dispositions: 1
+    :update_conversion: 2
+    :update_conversion_disposition: 2
+    :update_conversion_price: 2
+    :update_conversion_revenue: 1
+    :update_lead_price: 2
+    :update_sale_revenue: 1
+:advertisers:
+  :reports:
+    :bills: 1
+:affiliates:
+  :reports:
+    :bills: 3

data/circle.yml

@@ -0,0 +1,7 @@
+deployment:
+  production:
+    branch: master
+    commands:
+      - gem install geminabox
+      - gem build soapy_cake.gemspec
+      - gem inabox soapy_cake-*.gem --host $GEMINABOX_URL

data/lib/soapy_cake.rb

@@ -0,0 +1,8 @@
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/date'
+require 'soapy_cake/version'
+require 'soapy_cake/client'
+
+module SoapyCake
+  API_VERSIONS = YAML.load(File.read(File.expand_path('../../api_versions.yml', __FILE__)))
+end

data/lib/soapy_cake/client.rb

@@ -0,0 +1,145 @@
+require 'sekken'
+require 'active_support/core_ext/time/zones'
+
+module SoapyCake
+  class Client
+    attr_reader :service, :api_key, :domain, :role
+
+    def initialize(service, opts = {})
+      @service = service.to_sym
+      @version = opts[:version]
+      @role = opts[:role] || :admin
+
+      @domain = opts.fetch(:domain) do
+        if ENV['CAKE_DOMAIN'].present?
+          ENV['CAKE_DOMAIN']
+        else
+          raise 'We need a domain'
+        end
+      end
+
+      @api_key = opts.fetch(:api_key) do
+        if opts[:username] && opts[:password]
+          get_api_key(opts[:username], opts[:password])
+        elsif ENV['CAKE_API_KEY']
+          ENV['CAKE_API_KEY']
+        else
+          raise 'We need an API key here!'
+        end
+      end
+    end
+
+    def self.method_missing(method, opts = {})
+      new(method, opts)
+    end
+
+    def sekken_client(method)
+      self.class.sekken_client(wsdl_url(version(method)))
+    end
+
+    def self.sekken_client(url)
+      @sekken_clients ||= {}
+      @sekken_clients[url] ||= Sekken.new(url)
+    end
+
+    def method_missing(method, opts = {})
+      if supported?(method)
+        method = method.to_s
+        operation = sekken_client(method).operation(service, "#{service}Soap12", method.camelize)
+        operation.body = build_body(method, opts)
+        process_response(method, operation.call.body)
+      else
+        super
+      end
+    end
+
+    def known_params_for(method)
+      method = method.to_s
+      operation = sekken_client(method).operation(service, "#{service}Soap12", method.camelize)
+      operation.example_body
+    end
+
+    private
+
+    def build_body(method, opts)
+      {
+        method.camelize.to_sym => { api_key: api_key }.merge(
+          opts.each_with_object({}) do |(key, value), memo|
+            memo[key] = format_param(value)
+          end
+        )
+      }
+    end
+
+    def format_param(value)
+      case value
+      when Time
+        value.utc.strftime('%Y-%m-%dT%H:%M:%S')
+      when Date
+        value.strftime('%Y-%m-%dT00:00:00')
+      else
+        value
+      end
+    end
+
+    def process_response(method, response)
+      Time.use_zone('UTC') do
+        raise response[:fault][:reason][:text] if response[:fault]
+        node_name = {
+          'affiliate_summary' => 'affiliates',
+          'affiliate_tags' => 'tags',
+          'offer_summary' => 'offers',
+        }.fetch(method, method)
+        result = response[:"#{method}_response"][:"#{method}_result"]
+        raise result[:message] if result[:success] == false
+        return result unless result_has_collection?(result)
+        extract_collection(node_name, result).
+          map { |hash| remove_prefix(node_name, hash) }
+      end
+    end
+
+    def result_has_collection?(result)
+      !result.key?(:message)
+    end
+
+    def extract_collection(node_name, response)
+      node_name = node_name.to_sym
+      if response.key?(node_name)
+        return [] if response[node_name].nil?
+        response = response[node_name]
+      end
+      [response[response.keys.first]].flatten
+    end
+
+    def remove_prefix(prefix, object)
+      object.each_with_object({}) do |(k, v), m|
+        prefix_ = "#{prefix.singularize}_"
+        if k.to_s.start_with?(prefix_)
+          m[k[(prefix_.size)..-1].to_sym] = v
+        else
+          m[k] = v
+        end
+      end
+    end
+
+    def get_api_key(username, password)
+      operation = sekken_client(:get_api_key).operation('get', 'getSoap12', 'GetAPIKey')
+      operation.body = { GetAPIKey: { username: username, password: password } }
+      response = operation.call.body
+      response[:get_api_key_response][:get_api_key_result]
+    end
+
+    def wsdl_url(version)
+      role_path = (role && role != :admin) ? "/#{role}" : nil
+      "https://#{domain}#{role_path}/api/#{version}/#{service}.asmx?WSDL"
+    end
+
+    def version(method)
+      API_VERSIONS[role][service][method.to_sym]
+    end
+
+    def supported?(method)
+      API_VERSIONS[role][service].keys.include?(method)
+    end
+  end
+end

data/lib/soapy_cake/version.rb

@@ -0,0 +1,3 @@
+module SoapyCake
+  VERSION = '0.2.1'
+end

data/script/update_versions.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+SOURCE = 'https://support.getcake.com/hc/en-us/articles/200704900-Admin-API-Version-Tracker'
+
+require 'net/https'
+require 'bundler/setup'
+require 'nokogiri'
+require 'active_support/core_ext/string'
+require 'yaml'
+
+uri = URI.parse(SOURCE)
+
+http = Net::HTTP.new(uri.host, uri.port)
+http.use_ssl = true
+http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+request = Net::HTTP::Get.new(uri.request_uri)
+response = http.request(request)
+
+html = Nokogiri::HTML.parse(response.body)
+versions = {}
+
+html.css('div.article-body table').each do |table|
+  section_head = table.previous_element
+  # Find the section title in the previous elements
+  until section_head.text[/\w+/][/^[A-Z]+$/]
+    section_head = section_head.previous_element
+  end
+  section = section_head.text[/\w+/].downcase.to_sym
+  versions[section] = {}
+  table.css('tr')[1..-1].each do |row|
+    version, method = row.css('td').map(&:text)
+    method = method[/\w+/]
+    next if method.blank?
+    method = method.underscore.to_sym
+    versions[section][method] = version.to_i
+  end
+end
+
+yaml = YAML.load_file('api_versions.yml')
+yaml[:admin] = versions
+File.open('api_versions.yml', 'w') { |f| f << YAML.dump(yaml) }