google-dfp-api 0.22.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 686591c920a9aeac7e14108b382f67235521171b
-  data.tar.gz: b51d891c9ac928f54084afbe565a520dc038f08a
+  metadata.gz: c397f20b48dccdbd614f7987afba9304b4405471
+  data.tar.gz: 07f20684de0d8c47ca8b1de220422f5124d7e292
 SHA512:
-  metadata.gz: e2f171519098bcbca0efc52994c76561f49a9a402174002c2a5feadeb4af1d565c7664c7f80722ac5ce6a1a356201ab1b1d694e18ead4ab118cb18f593bc1d90
-  data.tar.gz: 5ca8da1155f23afa89fe7bb711ac30b5d85e8642ffe697f420eae67aa1754088cad3ec5b2f5fc1c7b18965e5993d1daf58061df6f3e2d5b6bd52e78972e1e68c
+  metadata.gz: ab2045bdfff1df0320cb8b96cf4d6731189c1927857e6319af40cf699e53844088a35bc0f44eabc064c9a1af51b7481ef97956aba525e2decbb65fe6779942bd
+  data.tar.gz: d8832b6c9a3d686942474b236acc77d74e913b6f3db7104d6bd843ebf7cd4e140da6d6820cd0d045b4f8725f970e489c569f52cd9f06b7ffe4dfa29a50525188

data/ChangeLog

@@ -1,3 +1,10 @@
+1.0.0:
+  - Major version bump. The library has been stable and feature complete for
+    some time, and this is more accurately reflected by this version number.
+  - No longer include test files in the built gem.
+  - Removing support for multiple environments.
+  - Require google-ads-common 1.0.0 or later from now on.
+
 0.22.0:
   - Added support for v201708.
   - Removed support for v201608.

data/dfp_api.yml

@@ -39,9 +39,6 @@
 
   # Required for all calls other than GetAllNetworks and MakeTestNetwork.
   :network_code: INSERT_NETWORK_CODE_HERE
-:service:
-  # Only production environment is now available.
-  :environment: PRODUCTION
 :connection:
   # Enable to request all responses to be compressed.
   :enable_gzip: false

data/lib/dfp_api/api_config.rb

@@ -32,7 +32,6 @@ module DfpApi
 
     # Set defaults
     DEFAULT_VERSION = :v201708
-    DEFAULT_ENVIRONMENT = :PRODUCTION
     LATEST_VERSION = :v201708
 
     # Set other constants
@@ -139,16 +138,14 @@ module DfpApi
                    :UserTeamAssociationService, :WorkflowRequestService],
     }
 
-    # Configure the different environments, with the base URL for each one
-    @@environment_config = {
-      :PRODUCTION => {
-        :oauth_scope => 'https://www.googleapis.com/auth/dfp',
-        :header_ns => 'https://www.google.com/apis/ads/publisher/',
-        :v201611 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201702 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201705 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201708 => 'https://ads.google.com/apis/ads/publisher/',
-      }
+    # Configure the base URL for each version and scope.
+    @@config = {
+      :oauth_scope => 'https://www.googleapis.com/auth/dfp',
+      :header_ns => 'https://www.google.com/apis/ads/publisher/',
+      :v201611 => 'https://ads.google.com/apis/ads/publisher/',
+      :v201702 => 'https://ads.google.com/apis/ads/publisher/',
+      :v201705 => 'https://ads.google.com/apis/ads/publisher/',
+      :v201708 => 'https://ads.google.com/apis/ads/publisher/'
     }
 
     public
@@ -158,10 +155,6 @@ module DfpApi
       DEFAULT_VERSION
     end
 
-    def self.default_environment
-      DEFAULT_ENVIRONMENT
-    end
-
     def self.latest_version
       LATEST_VERSION
     end
@@ -174,9 +167,8 @@ module DfpApi
       @@service_config
     end
 
-    def self.environment_config(environment, key)
-      return @@environment_config.include?(environment) ?
-          @@environment_config[environment][key] : nil
+    def self.config(key)
+      @@config[key]
     end
 
     def self.subdir_config

data/lib/dfp_api/version.rb

@@ -19,6 +19,6 @@
 
 module DfpApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.22.0'
+    CLIENT_LIB_VERSION = '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-dfp-api
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Danial Klimkin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.0.0
 description: google-dfp-api is a DFP API client library for Ruby
 email:
 - dfpapi-advisor@google.com
@@ -440,10 +440,6 @@ files:
 - lib/dfp_api/v201708/workflow_request_service.rb
 - lib/dfp_api/v201708/workflow_request_service_registry.rb
 - lib/dfp_api/version.rb
-- test/bugs/test_issue_00000007.rb
-- test/bugs/test_issue_00000081.rb
-- test/dfp_api/test_credential_handler.rb
-- test/dfp_api/test_dfp_api.rb
 homepage: https://github.com/googleads/google-api-ads-ruby
 licenses:
 - Apache-2.0
@@ -464,12 +460,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: google-dfp-api
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby Client libraries for DFP API
-test_files:
-- test/bugs/test_issue_00000007.rb
-- test/bugs/test_issue_00000081.rb
-- test/dfp_api/test_credential_handler.rb
-- test/dfp_api/test_dfp_api.rb
+test_files: []

data/test/bugs/test_issue_00000007.rb

@@ -1,113 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Tests issue #7.
-
-require 'nori'
-require 'ads_savon'
-require 'test/unit'
-
-require 'ads_common/config'
-require 'ads_common/savon_service'
-require 'ads_savon/soap/response'
-require 'dfp_api/v201608/line_item_service'
-
-class HeaderHandler
-  def prepare_request(http, soap)
-  end
-end
-
-# SavonService is abstract, defining a child class for the test.
-class StubService7 < AdsCommon::SavonService
-
-  public :get_module
-
-  def initialize(namespace, endpoint, version)
-    logger = Logger.new(STDERR)
-    @config = AdsCommon::Config.new({:library => {:logger => logger}})
-    super(@config, namespace, endpoint, version)
-    @header_handler = HeaderHandler.new
-  end
-
-  def get_module()
-    return DfpApi::V201608::LineItemService
-  end
-
-  def get_service_registry()
-    return DfpApi::V201608::LineItemService::LineItemServiceRegistry
-  end
-end
-
-class StubConfig
-  attr_reader :raise_errors
-end
-
-class TestDfpIssue7 < Test::Unit::TestCase
-
-  TEST_NAMESPACE = 'https://ads.google.com/apis/ads/publisher/'
-  TEST_ENDPOINT =
-      'https://ads.google.com/apis/ads/publisher/v201608/LineItemService?wsdl'
-  TEST_VERSION = :v201608
-
-  def test_issue_7_request()
-    args = {:line_items => [
-        {:order_id => 42, :id => 82, :web_property_code => ''}
-    ]}
-    want = '<webPropertyCode></webPropertyCode>'
-
-    savon_service =
-        StubService7.new(TEST_NAMESPACE, TEST_ENDPOINT, TEST_VERSION)
-    result = savon_service.send(
-        :handle_soap_request, :update_line_items, true, args, nil)
-
-    assert(result.include?(want),
-        "Expected '%s' but not found in:\n%s" % [want, result])
-  end
-
-  def test_issue_7_response()
-    args = get_xml_response_text()
-
-    response = GoogleAdsSavon::SOAP::Response.new(StubConfig.new, nil)
-    nori = response.send(:nori)
-
-    result = nori.parse(args)
-    line_item =
-        result[:body][:get_line_items_by_statement_response][:rval][:results]
-
-    assert_equal('', line_item[:web_property_code])
-  end
-
-  def get_xml_response_text()
-    return <<EOT
-  <soap:Body>
-    <getLineItemsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v201608">
-      <rval>
-        <totalResultSetSize>1</totalResultSetSize>
-        <startIndex>0</startIndex>
-        <results>
-          <orderId>41</orderId>
-          <id>42</id>
-          <name>name42</name>
-          <webPropertyCode></webPropertyCode>
-        </results>
-      </rval>
-    </getLineItemsByStatementResponse>
-  </soap:Body>
-EOT
-  end
-end

data/test/bugs/test_issue_00000081.rb

@@ -1,110 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Tests issue #81.
-
-require 'nori'
-require 'ads_savon'
-require 'test/unit'
-
-require 'ads_common/savon_service'
-require 'dfp_api/v201702/line_item_service'
-
-# SavonService is abstract, defining a child class for the test.
-class StubService81 < AdsCommon::SavonService
-
-  public :get_module
-
-  def initialize(namespace, endpoint, version)
-    @logger = Logger.new(STDERR)
-    @config = AdsCommon::Config.new({:library => {:logger => @logger}})
-    super(@config, namespace, endpoint, version)
-  end
-
-  def get_module()
-    return DfpApi::V201702::LineItemService
-  end
-end
-
-
-class TestDfpIssue81 < Test::Unit::TestCase
-
-  TEST_NAMESPACE = 'https://ads.google.com/apis/ads/publisher/'
-  TEST_ENDPOINT = (
-      'https://ads.google.com/apis/ads/publisher/v201702/LineItemService?wsdl')
-  TEST_VERSION = :v201702
-
-  def setup()
-    @stub_service =
-        StubService81.new(TEST_NAMESPACE, TEST_ENDPOINT, TEST_VERSION)
-    nori_options = {
-      :strip_namespaces      => true,
-      :convert_tags_to       => lambda { |tag| tag.snakecase.to_sym },
-      :advanced_typecasting  => false
-    }
-    @nori = Nori.new(nori_options)
-  end
-
-  def test_issue_81()
-    data = @nori.parse(get_xml_text())[:envelope][:body]
-    savon_service =
-        StubService81.new(TEST_NAMESPACE, TEST_ENDPOINT, TEST_VERSION)
-    assert_instance_of(DfpApi::V201702::LineItemService::ApiException,
-        savon_service.send(:exception_for_soap_fault, data))
-  end
-
-  def get_xml_text()
-    return <<EOT
-<?xml version="1.0"?>
-<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
-  <soap:Header>
-    <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v201702">
-      <requestId>abc123</requestId>
-      <responseTime>658</responseTime>
-    </ResponseHeader>
-  </soap:Header>
-  <soap:Body>
-    <soap:Fault>
-      <faultcode>soap:Server</faultcode>
-      <faultstring>
-        [PublisherQueryLanguageContextError.UNEXECUTABLE @ Unknown column: 'blah']
-      </faultstring>
-      <detail>
-        <ApiExceptionFault
-         xmlns="https://www.google.com/apis/ads/publisher/v201502">
-          <message>
-            [PublisherQueryLanguageContextError.UNEXECUTABLE
-             @ Unknown column: 'blah']
-          </message>
-          <errors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-           xsi:type="PublisherQueryLanguageContextError">
-            <fieldPath>Unknown column: 'blah'</fieldPath>
-            <trigger></trigger>
-            <errorString>
-              PublisherQueryLanguageContextError.UNEXECUTABLE
-            </errorString>
-            <reason>UNEXECUTABLE</reason>
-          </errors>
-        </ApiExceptionFault>
-      </detail>
-    </soap:Fault>
-  </soap:Body>
-</soap:Envelope>
-EOT
-  end
-end

data/test/dfp_api/test_credential_handler.rb

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2016, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Tests dfp credential handler.
-
-require 'logger'
-require 'test/unit'
-
-require 'ads_common/config'
-require 'dfp_api/credential_handler'
-
-# Overriding default access levels to public for tests.
-module DfpApi
-
-  class CredentialHandler
-    public :validate_headers_for_server
-  end
-end
-
-
-class TestCredentialHandler < Test::Unit::TestCase
-
-  def setup()
-    @logger = Logger.new(STDERR)
-    config = AdsCommon::Config.new({:library => {:logger => @logger}})
-    @handler = DfpApi::CredentialHandler.new(config)
-  end
-
-  def test_validate_headers_for_bad_application_name()
-    credentials1 = {:application_name => 'INSERT_APPLICATION_NAME_HERE'}
-    assert_raise(AdsCommon::Errors::AuthError) do
-      @handler.validate_headers_for_server(credentials1)
-    end
-
-    credentials2 = {:application_name => 'dfp_ruby_examplesEXTRATEXT'}
-    assert_raise(AdsCommon::Errors::AuthError) do
-      @handler.validate_headers_for_server(credentials2)
-    end
-
-    credentials3 = {:application_name => 'something awesome '}
-    assert_nothing_raised do
-      @handler.validate_headers_for_server(credentials3)
-    end
-    assert_equal(credentials3[:application_name], 'something awesome ')
-  end
-
-end

data/test/dfp_api/test_dfp_api.rb

@@ -1,118 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Tests the general API features.
-
-require 'test/unit'
-require 'tempfile'
-
-require 'dfp_api'
-
-
-class LoggerStub
-  attr_reader :last_warning
-  def warn(message)
-    @last_warning = message
-  end
-end
-
-module DfpApi
-  module ApiConfig
-    def self.default_config_filename=(value)
-      @default_config_filename = value
-    end
-
-    def self.default_config_filename
-      @default_config_filename
-    end
-  end
-end
-
-class TestDfpApi < Test::Unit::TestCase
-  DEFAULT_CONFIG_HASH = {
-      :authentication => {
-          :method => 'OAuth2',
-          :oauth2_client_id => 'myClientId',
-          :oauth2_client_secret => 'This is MY secret!',
-          :oauth2_token => 'my access token',
-          :application_name => 'ruby_test_suite',
-          :network_code => 1234567
-      }
-  }
-
-  DEFAULT_CONFIG_FILENAME = File.expand_path('../test_config.yml', __FILE__)
-  DEFAULT_FAILURE_FILENAME = 'test_notexists.yml'
-
-  def setup()
-    @logger = LoggerStub.new
-  end
-
-  # Test initializer with no arguments.
-  def test_initialize_nil()
-    # Set up a tempfile in ENV['HOME']
-    temp_file = Tempfile.new(['dfp_api', 'yml'], ENV['HOME'])
-    real_file = File.open(DEFAULT_CONFIG_FILENAME, 'r')
-    temp_file.write(real_file.read)
-    temp_file.flush()
-    real_file.close()
-    DfpApi::ApiConfig.default_config_filename = File.basename(temp_file.path)
-
-    assert_nothing_raised do
-      dfp_api = DfpApi::Api.new
-    end
-
-    temp_file.unlink()
-  end
-
-  # Test initializer with hash argument.
-  def test_initialize_hash()
-    assert_nothing_raised do
-      dfp_api = DfpApi::Api.new(DEFAULT_CONFIG_HASH)
-      check_config_data(dfp_api.config)
-    end
-  end
-
-  # Test initializer with filename argument.
-  def test_initialize_filename()
-    assert_nothing_raised do
-      dfp_api = DfpApi::Api.new(DEFAULT_CONFIG_FILENAME)
-      check_config_data(dfp_api.config)
-    end
-  end
-
-  # Test initializer with bad filename argument.
-  def test_initialize_filename_not_exists()
-    assert_raises(Errno::ENOENT) do
-      dfp_api = DfpApi::Api.new(DEFAULT_FAILURE_FILENAME)
-    end
-  end
-
-  # Utility method to check the actual data.
-  def check_config_data(config)
-    assert_equal(:OAUTH2, config.read('authentication.method'))
-    assert_equal('ruby_test_suite',
-        config.read('authentication.application_name'))
-    assert_equal('myClientId', config.read('authentication.oauth2_client_id'))
-    assert_equal('This is MY secret!', config.read(
-        'authentication.oauth2_client_secret'))
-    assert_equal('my access token', config.read('authentication.oauth2_token'))
-    assert_equal(1234567, config.read('authentication.network_code'))
-    assert_nil(config.read('item.not.exists'))
-    assert_equal(:default, config.read('item.not.exists', :default))
-  end
-end