awis-sdk-ruby 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f60e08f71c0092e6c7ff4185e1e64a6af7776d9
-  data.tar.gz: cb3a28d169416fb66d36ff7d662295b777709de7
+  metadata.gz: 84250ba83bc8498d3506fdf84111da57be3f2fc4
+  data.tar.gz: cb4821875ce36ffbf6a880d0f71cae358d48f504
 SHA512:
-  metadata.gz: b27b1755fc104f0fc196f1ed91c5e0d93408f3fbd62ccb39b3f7d02c135e2a34eca4db3d4a8a60ee819e0b9bf84aa48c8a392da7e5ed1c4d139e2f4474c0d553
-  data.tar.gz: 9d9e2c0011a964374a10a9d89680b57aeebbe44bc5333980f4e40fe163af26c699caecdfbf493f1222aa7f136c59ae084407409ea6223752ed78862f0bfff388
+  metadata.gz: 6e33e6d07dfa95bd5b19277324391d0e25709a1cc5a0628035946aa532267ed9ba2c4679365191b8691fe1269f19cf8798d8f9e056b9e099e962d47e64539180
+  data.tar.gz: ac257c8001b304f1a74f0374bc384ec028e7fd3cdf9bef02fe1614b71837b378d5871b13ce5a76734b3db119fda51d520c001c239c04524dad9386b71d33326b

data/.rubocop.yml

@@ -84,4 +84,4 @@ Style/NumericLiterals:
   Enabled: false
 
 Rails:
-  Enabled: true
+  Enabled: false

data/README.md

@@ -43,6 +43,7 @@ Returns object that contains attributes:
 * data_url
 * rank
 * asin
+* xml
 
 Returns object that contains relationships:
 
@@ -175,4 +176,4 @@ Awis is using `nokogiri` to parse XML documents.
 
 ### Copyright
 
-Copyright (c) Encore Shao. See LICENSE for details.
+Copyright (c) Encore Shao. See LICENSE for details.

data/lib/awis.rb

@@ -18,5 +18,5 @@ module Awis
   SERVICE_PATH          = 'api'
   SERVICE_NAME          = 'awis'
   SERVICE_REGION        = 'us-west-1'
-  SERVICE_HOST          = "#{SERVICE_NAME}.amazonaws.com"
+  SERVICE_HOST          = "#{SERVICE_NAME}.#{SERVICE_REGION}.amazonaws.com"
 end

data/lib/awis/api/traffic_history.rb

@@ -28,7 +28,7 @@ module Awis
 
         @arguments = arguments
         @arguments[:range] = arguments.fetch(:range, 31)
-        @arguments[:start] = arguments.fetch(:start) { Time.zone.now - (3600 * 24 * @arguments[:range].to_i) }
+        @arguments[:start] = arguments.fetch(:start) { Time.now - (3600 * 24 * @arguments[:range].to_i) }
       end
 
       def start_date

data/lib/awis/connection.rb

@@ -10,14 +10,14 @@ module Awis
     attr_reader :params, :secret_access_key, :access_key_id
 
     HEADERS = {
-      'Content-Type' => 'application/xml',
-      'Accept' => 'application/xml',
-      'User-Agent' => "awis-sdk-ruby v#{Awis::VERSION}"
+      'accept' => 'application/xml',
+      'content-type' => 'application/xml',
+      'user-agent' => "awis-sdk-ruby v#{Awis::VERSION}"
     }.freeze
 
     def initialize(options = {})
-      @secret_access_key = options.fetch(:secret_access_key, Awis.config.access_key_id)
-      @access_key_id     = options.fetch(:access_key_id, Awis.config.secret_access_key)
+      @secret_access_key = options.fetch(:secret_access_key, Awis.config.secret_access_key)
+      @access_key_id     = options.fetch(:access_key_id, Awis.config.access_key_id)
       raise CertificateError, 'Amazon access certificate is missing!' if @secret_access_key.nil? || @access_key_id.nil?
 
       setup_options!
@@ -32,7 +32,7 @@ module Awis
 
     def get(params = {})
       @params = params
-      handle_response(request).body.force_encoding(Encoding::UTF_8)
+      handle_response(request).body
     end
 
     private
@@ -77,7 +77,7 @@ module Awis
     end
 
     def uri
-      @uri ||= URI.parse("#{protocol}://#{Awis::SERVICE_HOST}/#{Awis::SERVICE_PATH}?" << query)
+      @uri ||= URI.parse("#{protocol}://#{Awis::SERVICE_HOST}/#{Awis::SERVICE_PATH}?#{query}")
     end
 
     def headers

data/lib/awis/models/url_info.rb

@@ -3,17 +3,21 @@
 module Awis
   module Models
     class UrlInfo < Base
-      attr_accessor :data_url, :rank, :asin, :contact_info, :content_data, :usage_statistics, :related_links, :categories
+      attr_accessor :data_url, :rank, :asin, :contact_info, :content_data, :usage_statistics, :related_links,
+                    :categories, :xml, :contributing_subdomains, :rank_by_country
 
       def initialize(response)
         @usage_statistics = []
         @related_links = []
         @categories = []
+        @contributing_subdomains = []
+        @rank_by_country = []
 
         setup_data! loading_response(response)
       end
 
       def setup_data!(response)
+        @xml = response
         content_data = {
           owned_domains: []
         }
@@ -23,94 +27,122 @@ module Awis
         statistics = []
         related_related_links = []
         category_data = []
+        rank_by_country = []
+        contributing_subdomains = []
 
         response.each_node do |node, path|
           text = node.inner_xml
-          text = text.to_i if text.to_i.to_s == text && node.name != 'aws:Delta'
-          text = nil if text.class == String && text.empty?
+          candidate_text = text.delete(',')
+          value = if integer_value?(candidate_text) && node.name != 'aws:Delta'
+                    candidate_text.to_i
+                  elsif float_value?(candidate_text)
+                    candidate_text.to_f
+                  elsif text.is_a?(String) && text.empty?
+                    nil
+                  else
+                    text
+                  end
 
           if node.name == 'aws:RequestId'
-            @request_id ||= text
+            @request_id ||= value
           elsif node.name == 'aws:StatusCode'
-            @status_code ||= text
+            @status_code ||= value
           elsif node.name == 'aws:DataUrl' && path == "#{traffic_node_name}/aws:DataUrl"
-            @data_url = text
+            @data_url = value
           elsif node.name == 'aws:Asin' && path == "#{traffic_node_name}/aws:Asin"
-            @asin = text
+            @asin = value
           elsif node.name == 'aws:Rank' && path == "#{traffic_node_name}/aws:Rank"
-            @rank = text
+            @rank = value
           elsif node.name == 'aws:DataUrl' && path == "#{content_node_name}/aws:DataUrl"
-            content_data[:data_url] = text
+            content_data[:data_url] = value
           elsif node.name == 'aws:Title' && path == "#{content_node_name}/aws:SiteData/aws:Title"
-            content_data[:site_title] = text
+            content_data[:site_title] = value
           elsif node.name == 'aws:Description'
-            content_data[:site_description] = text
+            content_data[:site_description] = value
           elsif node.name == 'aws:MedianLoadTime'
-            content_data[:speed_median_load_time] = text
+            content_data[:speed_median_load_time] = value
           elsif node.name == 'aws:Percentile'
-            content_data[:speed_percentile] = text
+            content_data[:speed_percentile] = value
           elsif node.name == 'aws:AdultContent'
-            content_data[:adult_content] = text
+            content_data[:adult_content] = value
           elsif node.name == 'aws:Locale'
-            content_data[:language_locale] = text
+            content_data[:language_locale] = value
           elsif node.name == 'aws:LinksInCount'
-            content_data[:links_in_count] = text
+            content_data[:links_in_count] = value
           elsif node.name == 'aws:Domain' && path == "#{content_node_name}/aws:OwnedDomains/aws:OwnedDomain/aws:Domain"
-            content_data[:owned_domains] << { domain: text }
+            content_data[:owned_domains] << { domain: value }
           elsif node.name == 'aws:Title' && path == "#{content_node_name}/aws:OwnedDomains/aws:OwnedDomain/aws:Title"
-            content_data[:owned_domains] << { title: text }
+            content_data[:owned_domains] << { title: value }
           elsif node.name == 'aws:OnlineSince'
-            content_data[:online_since] = text
+            content_data[:online_since] = value
           elsif node.name == 'aws:DataUrl' && path == "#{root_node_name}/aws:ContactInfo/aws:DataUrl"
-            contact_info[:data_url] = text
+            contact_info[:data_url] = value
           elsif node.name == 'aws:OwnerName'
-            contact_info[:owner_name] = text
+            contact_info[:owner_name] = value
           elsif node.name == 'aws:Email'
-            contact_info[:email] = text
+            contact_info[:email] = value
           elsif node.name == 'aws:PhysicalAddress'
-            contact_info[:physical_address] = text
+            contact_info[:physical_address] = value
           elsif node.name == 'aws:CompanyStockTicker'
-            contact_info[:company_stock_ticker] = text
+            contact_info[:company_stock_ticker] = value
           elsif node.name == 'aws:PhoneNumber'
-            contact_info[:phone_numbers] << text
+            contact_info[:phone_numbers] << value
           elsif node.name == 'aws:DataUrl' && path == "#{related_links_node_name}/aws:DataUrl"
-            related_related_links << { data_url: text }
+            related_related_links << { data_url: value }
           elsif node.name == 'aws:NavigableUrl' && path == "#{related_links_node_name}/aws:NavigableUrl"
-            related_related_links << { navigable_url: text }
+            related_related_links << { navigable_url: value }
           elsif node.name == 'aws:Title' && path == "#{related_links_node_name}/aws:Title"
-            related_related_links << { title: text }
+            related_related_links << { title: value }
           elsif node.name == 'aws:Title' && path == "#{categories_node_name}/aws:Title"
-            category_data << { title: text }
+            category_data << { title: value }
           elsif node.name == 'aws:AbsolutePath' &&  path == "#{categories_node_name}/aws:AbsolutePath"
-            category_data << { absolute_path: text }
+            category_data << { absolute_path: value }
           elsif node.name == 'aws:Months' && path == "#{statistic_node_name}/aws:TimeRange/aws:Months"
-            statistics << { time_range_months: text }
+            statistics << { time_range_months: value }
           elsif node.name == 'aws:Days' && path == "#{statistic_node_name}/aws:TimeRange/aws:Days"
-            statistics << { time_range_days: text }
+            statistics << { time_range_days: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:Rank/aws:Value"
-            statistics << { rank_value: text }
+            statistics << { rank_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:Rank/aws:Delta"
-            statistics << { rank_delta: text }
+            statistics << { rank_delta: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:Reach/aws:Rank/aws:Value"
-            statistics << { reach_rank_value: text }
+            statistics << { reach_rank_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:Reach/aws:Rank/aws:Delta"
-            statistics << { reach_rank_delta: text }
+            statistics << { reach_rank_delta: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:Reach/aws:PerMillion/aws:Value"
-            statistics << { reach_per_million_value: text }
+            statistics << { reach_per_million_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:Reach/aws:PerMillion/aws:Delta"
-            statistics << { reach_per_million_delta: text }
+            statistics << { reach_per_million_delta: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:PageViews/aws:PerMillion/aws:Value"
-            statistics << { reach_page_views_per_million_value: text }
+            statistics << { page_views_per_million_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:PageViews/aws:PerMillion/aws:Delta"
-            statistics << { reach_page_views_per_million_delta: text }
+            statistics << { page_views_per_million_delta: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:PageViews/aws:Rank/aws:Value"
-            statistics << { reach_page_views_rank_value: text }
+            statistics << { page_views_rank_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:PageViews/aws:Rank/aws:Delta"
-            statistics << { reach_page_views_rank_delta: text }
+            statistics << { page_views_rank_delta: value }
           elsif node.name == 'aws:Value' && path == "#{statistic_node_name}/aws:PageViews/aws:PerUser/aws:Value"
-            statistics << { reach_page_views_per_user_value: text }
+            statistics << { page_views_per_user_value: value }
           elsif node.name == 'aws:Delta' && path == "#{statistic_node_name}/aws:PageViews/aws:PerUser/aws:Delta"
-            statistics << { reach_page_views_per_user_delta: text }
+            statistics << { page_views_per_user_delta: value }
+          elsif node.name == 'aws:Country' && path == rank_by_country_node_name
+            rank_by_country << { country_code: node.attributes['Code'] }
+          elsif node.name == 'aws:Rank' && path == "#{rank_by_country_node_name}/aws:Rank"
+            rank_by_country << { rank: value }
+          elsif node.name == 'aws:PageViews' && path == "#{rank_by_country_node_name}/aws:Contribution/aws:PageViews"
+            rank_by_country << { contribution_page_views: value }
+          elsif node.name == 'aws:Users' && path == "#{rank_by_country_node_name}/aws:Contribution/aws:Users"
+            rank_by_country << { contribution_users: value }
+          elsif node.name == 'aws:DataUrl' && path == "#{contributing_subdomains_node_name}/aws:DataUrl"
+            contributing_subdomains << { data_url: value }
+          elsif node.name == 'aws:Months' && path == "#{contributing_subdomains_node_name}/aws:TimeRange/aws:Months"
+            contributing_subdomains << { time_range_months: value }
+          elsif node.name == 'aws:Percentage' && path == "#{contributing_subdomains_node_name}/aws:Reach/aws:Percentage"
+            contributing_subdomains << { reach_percentage: value }
+          elsif node.name == 'aws:Percentage' && path == "#{contributing_subdomains_node_name}/aws:PageViews/aws:Percentage"
+            contributing_subdomains << { page_views_percentage: value }
+          elsif node.name == 'aws:PerUser' && path == "#{contributing_subdomains_node_name}/aws:PageViews/aws:PerUser"
+            contributing_subdomains << { page_views_per_user: value }
           end
         end
 
@@ -120,6 +152,8 @@ module Awis
         relationship_collections(@usage_statistics, statistics, 13, UsageStatistic)
         relationship_collections(@related_links, related_related_links, 3, RelatedLink)
         relationship_collections(@categories, category_data, 3, CategoryData)
+        relationship_collections(@rank_by_country, rank_by_country, 4, RankByCountry)
+        relationship_collections(@contributing_subdomains, contributing_subdomains, 5, ContributingSubdomain)
       end
 
       def is_404?
@@ -155,6 +189,126 @@ module Awis
       def statistic_node_name
         "#{traffic_node_name}/aws:UsageStatistics/aws:UsageStatistic"
       end
+
+      def contributing_subdomains_node_name
+        "#{traffic_node_name}/aws:ContributingSubdomains/aws:ContributingSubdomain"
+      end
+
+      def rank_by_country_node_name
+        "#{traffic_node_name}/aws:RankByCountry/aws:Country"
+      end
+
+      def has_data?
+        !@rank.nil?
+      end
+
+      def geos_sorted
+        rank_by_country.select { |rbc| !rbc.rank.nil? && !rbc.contribution_page_views.nil? }.
+          sort_by { |rbc| - rbc.contribution_page_views.round }.
+          map { |rbc| { rbc.country_code => rbc.contribution_page_views.round } }
+      end
+
+      def geos_hash
+        @geos_hash ||= geos_sorted.reduce({}, :merge)
+      end
+
+      def domains
+        content_data.owned_domains.map(&:domain)
+      end
+
+      def contributing_hostnames
+        contributing_subdomains.map(&:data_url).reject { |hostname| hostname == 'OTHER' }
+      end
+
+      def pvs_per_user
+        usage_statistics.first.page_views_per_user_value
+      end
+
+      def pvs_rank
+        usage_statistics.first.page_views_rank_value
+      end
+
+      def get_pvs_per_mil
+        usage_statistics.first.page_views_per_million_value
+      end
+
+      def speed_percentile
+        content_data.speed_percentile
+      end
+
+      def get_median_load_time
+        content_data.speed_median_load_time
+      end
+
+      def daily_GDN_page_views
+        if rank
+          alexa_gdn.each do |max_pvs, gdn_range|
+            return gdn_range if rank > max_pvs
+          end
+        end
+      end
+
+      def speed_rating
+        if get_median_load_time
+          alexa_speed_rating.each do |max_load_time, rating|
+            return rating if get_median_load_time > max_load_time
+          end
+        end
+        'AVERAGE ( < 5s)'
+      end
+
+      def alexa_speed_rating
+        {
+          2200 => 'POOR ( > 5s)',
+          1200 => 'AVERAGE ( < 5s)',
+          0 => 'GOOD ( < 3s)'
+        }
+      end
+
+      def rank_page_view
+        {
+          20000 => '< 1K',
+          5000 => '1K - 10K',
+          3000 => '10K - 100K',
+          1900 => '100K - 500K',
+          1300 => '500K - 1M',
+          850 => '2M - 5M',
+          550 => '5M - 10M',
+          350 => '10M - 20M',
+          200 => '20M - 50M',
+          100 => '50M - 100M',
+          28 => '100M+'
+        }
+      end
+
+      def alexa_gdn
+        {
+          250000 => '< 1K',
+          100000 => '1K - 10K',
+          50000 => '10K - 100K',
+          20000 => '100K - 500K',
+          10000 => '500K - 1M',
+          5000 => '1M - 2M',
+          2000 => '2M - 5M',
+          1000 => '5M - 10M',
+          500 => '10M - 20M',
+          150 => '20M - 50M',
+          30 => '50M - 100M',
+          0 => '100M+'
+        }
+      end
+
+      private
+
+      def integer_value?(text)
+        text.to_i.to_s == text
+      end
+
+      def float_value?(text)
+        !!Float(text.delete('%'))
+      rescue StandardError
+        false
+      end
     end
 
     class ContentData < BaseEntity
@@ -190,7 +344,7 @@ module Awis
       end
 
       def phone_number_collections(phone_numbers)
-        return @phone_numbers = [] if phone_numbers.blank?
+        return @phone_numbers = [] if phone_numbers.nil? || phone_numbers.empty?
 
         phone_numbers.map { |item| @phone_numbers << PhoneNumber.new(item) }
       end
@@ -212,12 +366,12 @@ module Awis
       attr_accessor :time_range_months, :time_range_days, :rank_value, :rank_delta,
                     :reach_rank_value, :reach_rank_delta,
                     :reach_per_million_value, :reach_per_million_delta,
-                    :reach_page_views_per_million_value, :reach_page_views_per_million_delta,
-                    :reach_page_views_rank_value, :reach_page_views_rank_delta,
-                    :reach_page_views_per_user_value, :reach_page_views_per_user_delta
+                    :page_views_per_million_value, :page_views_per_million_delta,
+                    :page_views_rank_value, :page_views_rank_delta,
+                    :page_views_per_user_value, :page_views_per_user_delta
 
       def range_type
-        return 'month' if time_range_months.present?
+        return 'month' unless time_range_months.nil? || time_range_months.empty?
 
         'day'
       end
@@ -226,5 +380,13 @@ module Awis
         (time_range_months || time_range_days)
       end
     end
+
+    class ContributingSubdomain < BaseEntity
+      attr_accessor :data_url, :time_range_months, :reach_percentage, :page_views_percentage, :page_views_per_user
+    end
+
+    class RankByCountry < BaseEntity
+      attr_accessor :country_code, :rank, :contribution_page_views, :contribution_users
+    end
   end
 end

data/lib/awis/utils/xml.rb

@@ -3,6 +3,8 @@
 module Awis
   module Utils
     class XML
+      attr_reader :data
+
       def initialize(data)
         @data = data
       end

data/lib/awis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Awis
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awis-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Encore Shao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sigv4