urbanairship 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 169148502585341b7938add240f3595e2124e56228916a1ad73b72f4e457885e
-  data.tar.gz: da1a1067c809c43bed0b0df1ebfc55d28443c2adcb1d5c0c8f3311dbd070b378
+  metadata.gz: fffdb1489ab1f833e816db52d94b9aea7dac527f07bde6507af1dee57f491140
+  data.tar.gz: 2255e7731044332f60b883568929e197905a690c45d905d0a75214806163434a
 SHA512:
-  metadata.gz: 6f04b2d733ed47e8bf8779cf3844d67962b0b7815c9450b5112cb706b81e8c8f566660034f21a8762a6ddc9ac6c547e43fdbc11d083e881096bac53315d9f8d2
-  data.tar.gz: fdd59798309c0dca97e596c35684ccab4f1cf04d9ffe7fb72eb6964a5466c126c6d47c236f9b50f784b4b1ba1e5a455b00950353aa9c77ffb62aa48ace89a2ee
+  metadata.gz: c39e8417e51bd08077a8658589cdee0db2639e5e5d60e6de2596aa361e9640f16cb25ff284cfa55da044dd814b1b01001b84bc7b1c1dbcbbdc441c1dab7b6405
+  data.tar.gz: 209ebf90c4d266092557e387d0479ccaf8fbd3d07d05f12f78e74186c4fd0c32a00a83b306994c64de9961554cd7eb39b115dc32b5130cc9c2f564553df72eb5

data/CHANGELOG

@@ -1,3 +1,8 @@
+--------------------
+7.0.0
+--------------------
+- Refactors base url naming
+
 --------------------
 6.0.0
 --------------------

data/README.rst

@@ -38,17 +38,23 @@ Installation
 
 If you have the ``bundler`` gem (if not you can get it with
 ``$ gem install bundler``) add this line to your application's
-Gemfile::
+Gemfile:
 
-    >>> gem 'urbanairship'
+.. code-block::
 
-And then execute::
+   >>> $ gem 'urbanairship'
 
-    >>> $ bundle
+And then execute:
 
-OR install it yourself as::
+.. code-block::
 
-    >>> gem install urbanairship
+   >>> $ bundle
+
+OR install it yourself as:
+
+.. code-block::
+
+   >>> $ gem install urbanairship
 
 
 Configuration
@@ -56,28 +62,35 @@ Configuration
 
 In your app initialization, you can do something like the following:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.server = 'go.airship.eu'
-    >>>   config.log_path = '/path/to/your/logfile'
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+     config.log_path = '/path/to/your/logfile'
+     config.log_level = Logger::WARN
+     config.timeout = 60
+   end
+
 
 If you want to use a custom logger (e.g Rails.logger), you can do:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.custom_logger = Rails.logger
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.custom_logger = Rails.logger
+     config.log_level = Logger::WARN
+   end
 
 Available Configurations
 ------------------------
 
 - **log_path**: Allows to define the folder where the log file will be created (the default is nil).
 - **log_level**: Allows to define the log level and only messages at that level or higher will be printed (the default is INFO).
+- **server**: Allow to define the Airship server you want to use ("go.airship.eu" or "go.urbanairship.com")
 - **timeout**: Allows to define the request timeout in seconds (the default is 5).
 
 
@@ -97,28 +110,71 @@ information.
 Broadcast to All Devices
 ------------------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.all
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
 
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.all
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
 
 Simple Tag Push
 ---------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.tag('some_tag')
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
+
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.tag('some_tag')
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
+
+Specify the Airship server used to make your requests
+-----------------------------------------------------
+By default, the request will be sent to the 'go.airship.us' server:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+
+You can change the server globally in the Urbanairship configuration:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+   # request will be sent to the 'go.airship.eu' server
+
+Finally, you can change the targeted server on a request basis:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
 
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.airship.us')
+   # The Urbanairship configuration is overridden by the client and the
+   # request will be sent to the 'go.airship.us' server
 
 Contributing
 ============

data/lib/urbanairship/ab_tests/ab_test.rb

@@ -19,7 +19,7 @@ module Urbanairship
             def list_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: experiments_url(format_url_with_params)
+                    path: experiments_path(format_url_with_params)
                 )
                 logger.info("Looking up A/B Tests for project")
                 response
@@ -29,7 +29,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: experiments_url,
+                    path: experiments_path,
                     content_type: 'application/json'
                 )
                 logger.info("Created A/B Test")
@@ -39,7 +39,7 @@ module Urbanairship
             def list_scheduled_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: experiments_url('scheduled' + format_url_with_params)
+                    path: experiments_path('scheduled' + format_url_with_params)
                 )
                 logger.info("Looking up scheduled A/B Tests for project")
                 response
@@ -49,7 +49,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to delete individual A/B test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: experiments_url('scheduled/' + experiment_id)
+                    path: experiments_path('scheduled/' + experiment_id)
                 )
                 logger.info("Deleting A/B test with ID #{experiment_id}")
                 response
@@ -59,7 +59,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: experiments_url('validate'),
+                    path: experiments_path('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating A/B Test")
@@ -70,7 +70,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to lookup individual A/B Test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: experiments_url(experiment_id)
+                    path: experiments_path(experiment_id)
                 )
                 logger.info("Looking up A/B test with ID #{experiment_id}")
                 response

data/lib/urbanairship/automations/automation.rb

@@ -22,7 +22,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: pipelines_url,
+                    path: pipelines_path,
                     content_type: 'application/json'
                 )
                 logger.info("Created Automation")
@@ -32,7 +32,7 @@ module Urbanairship
             def list_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: pipelines_url(format_url_with_params)
+                    path: pipelines_path(format_url_with_params)
                 )
                 logger.info("Looking up automations for project")
                 response
@@ -41,7 +41,7 @@ module Urbanairship
             def list_deleted_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: pipelines_url('deleted' + format_url_with_params)
+                    path: pipelines_path('deleted' + format_url_with_params)
                 )
                 logger.info("Looking up deleted automations for project")
                 response
@@ -51,7 +51,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: pipelines_url('validate'),
+                    path: pipelines_path('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
@@ -62,7 +62,7 @@ module Urbanairship
                 fail ArgumentError, 'pipeline_id must be set to lookup individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: pipelines_url(pipeline_id)
+                    path: pipelines_path(pipeline_id)
                 )
                 logger.info("Looking up automation with id #{pipeline_id}")
                 response
@@ -74,7 +74,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'PUT',
                     body: JSON.dump(pipeline_object),
-                    url: pipelines_url(pipeline_id),
+                    path: pipelines_path(pipeline_id),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
@@ -85,7 +85,7 @@ module Urbanairship
                 fail ArgumentError, 'pipeline_id must be set to delete individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: pipelines_url(pipeline_id)
+                    path: pipelines_path(pipeline_id)
                 )
                 logger.info("Deleting automation with id #{pipeline_id}")
                 response

data/lib/urbanairship/client.rb

@@ -13,11 +13,15 @@ module Urbanairship
       #
       # @param [Object] key Application Key
       # @param [Object] secret Application Secret
+      # @param [String] server Airship server to use ("go.airship.eu" or "go.urbanairship.com").
+      #                        Used only when the request is sent with a "path", not an "url".
       # @param [String] token Application Auth Token (for custom events endpoint)
       # @return [Object] Client
-      def initialize(key: required('key'), secret: required('secret'), token: nil)
+      def initialize(key: required('key'), secret: required('secret'),
+                     server: Urbanairship.configuration.server, token: nil)
         @key = key
         @secret = secret
+        @server = server
         @token = token
       end
 
@@ -25,12 +29,13 @@ module Urbanairship
       #
       # @param [Object] method HTTP Method
       # @param [Object] body Request Body
+      # @param [Object] path Request path
       # @param [Object] url Request URL
       # @param [Object] content_type Content-Type
       # @param [Object] encoding Encoding
       # @param [Symbol] auth_type (:basic|:bearer)
       # @return [Object] Push Response
-      def send_request(method: required('method'), url: required('url'), body: nil,
+      def send_request(method: required('method'), path: nil, url: nil, body: nil,
                        content_type: nil, encoding: nil, auth_type: :basic)
         req_type = case method
           when 'GET'
@@ -45,17 +50,21 @@ module Urbanairship
             fail 'Method was not "GET" "POST" "PUT" or "DELETE"'
         end
 
+        raise ArgumentError.new("path and url can't be both nil") if path.nil? && url.nil?
+
         headers = {'User-agent' => 'UARubyLib/' + Urbanairship::VERSION}
         headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
         headers['Content-type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
-        
+
         if auth_type == :bearer
           raise ArgumentError.new('token must be provided as argument if auth_type=bearer') if @token.nil?
           headers['X-UA-Appkey'] = @key
           headers['Authorization'] = "Bearer #{@token}"
         end
 
+        url = "https://#{@server}/api#{path}" unless path.nil?
+
         debug = "Making #{method} request to #{url}.\n"+ "\tHeaders:\n"
         debug += "\t\tcontent-type: #{content_type}\n" unless content_type.nil?
         debug += "\t\tcontent-encoding: gzip\n" unless encoding.nil?

data/lib/urbanairship/common.rb

@@ -4,68 +4,64 @@ require 'urbanairship/loggable'
 module Urbanairship
   # Features mixed in to all classes
   module Common
-    def url_for(path)
-      "https://#{Urbanairship.configuration.server}/api#{path}"
+    def apid_path(path='')
+      "/apids/#{path}"
     end
 
-    def apid_url(path='')
-      url_for("/apids/#{path}")
+    def channel_path(path='')
+      "/channels/#{path}"
     end
 
-    def channel_url(path='')
-      url_for("/channels/#{path}")
+    def create_and_send_path(path='')
+      "/create-and-send/#{path}"
     end
 
-    def create_and_send_url(path='')
-      url_for("/create-and-send/#{path}")
+    def custom_events_path(path='')
+      "/custom-events/#{path}"
     end
 
-    def custom_events_url(path='')
-      url_for("/custom-events/#{path}")
+    def device_token_path(path='')
+      "/device_tokens/#{path}"
     end
 
-    def device_token_url(path='')
-      url_for("/device_tokens/#{path}")
+    def experiments_path(path='')
+      "/experiments/#{path}"
     end
 
-    def experiments_url(path='')
-      url_for("/experiments/#{path}")
+    def lists_path(path='')
+      "/lists/#{path}"
     end
 
-    def lists_url(path='')
-      url_for("/lists/#{path}")
+    def location_path(path='')
+      "/location/#{path}"
     end
 
-    def location_url(path='')
-      url_for("/location/#{path}")
+    def named_users_path(path='')
+      "/named_users/#{path}"
     end
 
-    def named_users_url(path='')
-      url_for("/named_users/#{path}")
+    def open_channel_path(path='')
+      "/open/#{path}"
     end
 
-    def open_channel_url(path='')
-      channel_url("/open/#{path}")
+    def pipelines_path(path='')
+      "/pipelines/#{path}"
     end
 
-    def pipelines_url(path='')
-      url_for("/pipelines/#{path}")
+    def push_path(path='')
+      "/push/#{path}"
     end
 
-    def push_url(path='')
-      url_for("/push/#{path}")
+    def reports_path(path='')
+      "/reports/#{path}"
     end
 
-    def reports_url(path='')
-      url_for("/reports/#{path}")
+    def schedules_path(path='')
+      "/schedules/#{path}"
     end
 
-    def schedules_url(path='')
-      url_for("/schedules/#{path}")
-    end
-
-    def segments_url(path='')
-      url_for("/segments/#{path}")
+    def segments_path(path='')
+      "/segments/#{path}"
     end
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
@@ -161,36 +157,18 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @next_page = nil
-        @data_list = nil
-        @data_attribute = nil
         @count = 0
-      end
-
-      def load_page
-        return false unless @next_page
-        response = @client.send_request(
-            method: 'GET',
-            url: @next_page
-        )
-        logger.info("Retrieving data from: #{@next_page}")
-        check_next_page = response['body']['next_page']
-        if check_next_page != @next_page
-          @next_page = check_next_page
-        elsif check_next_page
-          # if check_page = next_page, we have repeats in the response.
-          # and we don't want to load them
-          return false
-        else
-          @next_page = nil
-        end
-        @data_list = response['body'][@data_attribute]
-        true
+        @data_attribute = nil
+        @data_list = nil
+        @next_page_path = nil
+        @next_page_url = nil
       end
 
       def each
-        while load_page
-          @data_list.each do | value |
+        while @next_page_path || @next_page_url
+          load_page
+
+          @data_list.each do |value|
             @count += 1
             yield value
           end
@@ -200,6 +178,47 @@ module Urbanairship
       def count
         @count
       end
+
+      private
+
+      def load_page
+        logger.info("Retrieving data from: #{@next_page_url || @next_page_path}")
+        params = {
+            method: 'GET',
+            path: @next_page_path,
+            url: @next_page_url
+          }.select { |k, v| !v.nil? }
+        response = @client.send_request(params)
+
+        @data_list = get_new_data(response)
+        @next_page_url = get_next_page_url(response)
+        @next_page_path = nil
+      end
+
+      def extract_next_page_url(response)
+        response['body']['next_page']
+      end
+
+      def get_new_data(response)
+        potential_next_page_url = extract_next_page_url(response)
+
+        # if potential_next_page_url is the same as the current page, we have
+        # repeats in the response and we don't want to load them
+        return [] if potential_next_page_url && get_next_page_url(response).nil?
+
+        response['body'][@data_attribute]
+      end
+
+      def get_next_page_url(response)
+        potential_next_page_url = extract_next_page_url(response)
+        return nil if potential_next_page_url.nil?
+
+        # if potential_next_page_url is the same as the current page, we have
+        # repeats in the response and we don't want to check the next pages
+        return potential_next_page_url if @next_page_url && potential_next_page_url != @next_page_url
+        return potential_next_page_url if @next_page_path && !potential_next_page_url.end_with?(@next_page_path)
+        nil
+      end
     end
   end
 end