awis-sdk-ruby_ 1.1.1p1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 820841628f9886a0dd31e6729757b845a85aab18b7c299605db60b9465dd4f4d
+  data.tar.gz: 1f5f504d1ff3e2ef0ba25beb3fe7f381d36099cd6317acbf95681c85ddccadea
+SHA512:
+  metadata.gz: a2cb847891bd5bc07e815ddf25c36a5348b28c7649b9beb146412da3fd8c7317806abf80b53e7bb9157ff3efc588d6790e7338592812846d04d321811227f9fd
+  data.tar.gz: 331a8f2566a9cdcf17b41cc140cb8fb9bea1a84cf52c04f9156ab795ebbbfa3c327249a332605efeff10dfec0348a4ed62e9c3ffea29fa60fa83ca7cae42e5b2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+awis.yml
+
+.ruby-version
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,87 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - '**/*.yml'
+    - 'test/**/*'
+    - 'pkg/*'
+    - 'tmp/*'
+
+Style/StringLiterals:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/RedundantFreeze:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/**/*'
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Layout/CaseIndentation:
+  # Valid values are: case, end
+  EnforcedStyle: end
+  IndentOneStep: false
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 10
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Rails:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+notifications:
+  disabled: true
+bundler_args: --without extra
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.2.3
+  - 2.3.0
+  - 2.4.0
+env:
+  - XML_PARSER=nokogiri

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'bundler'
+gem 'rake'
+
+gemspec

data/README.md

@@ -0,0 +1,179 @@
+## Amazon - Alexa Web Information Service (AWIS)
+Ruby Library for AWIS REST API - See: [Alexa Docs](http://docs.amazonwebservices.com/AlexaWebInfoService/latest/)
+
+### How to installation
+
+```
+gem install awis-sdk-ruby
+```
+
+### How to usage
+
+##### Configure your amazon certificate
+
+```
+require 'awis'
+
+AWIS_CONFIG = YAML.load(File.read('awis.yml'))
+Awis.config do |c|
+  c.access_key_id = AWIS_CONFIG['access_key_id']
+  c.secret_access_key = AWIS_CONFIG['secret_access_key']
+  c.debug = AWIS_CONFIG['debug']
+  c.protocol = 'https'    # Default 'https'
+  c.timeout = 10          # Default 10
+  c.open_timeout = 10     # Default 10
+  c.logger = false        # Default nil
+end
+```
+
+##### Get UrlInfo Information
+
+``` ruby
+client = Awis::Client.new
+url_info = client.url_info(url: "site.com")
+```
+
+If you looking for the API request URI:
+
+* Awis::API::UrlInfo.new.load_request_uri(url: 'site.com')
+
+
+Returns object that contains attributes:
+
+* data_url
+* rank
+* asin
+* xml
+
+Returns object that contains relationships:
+
+* contact_info [:data_url, :owner_name, :email, :physical_address, :company_stock_ticker, :phone_numbers]
+* content_data [:data_url, :site_title, :site_description, :speed_median_load_time, :speed_percentile, :adult_content, :language_locale, :links_in_count, :owned_domains]
+* usage_statistics [: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]
+    - add two methods: [range_type, range_count]
+* related_links [:data_url, :navigable_url, :title]
+* categories [:title, :absolute_path]
+
+New methods:
+
+* is_404?
+
+You can specify options:
+
+* url
+* response_group - which data to include in response (i.e. ["rank", "contact_info", "content_data"]) - defaults to all available
+
+##### Get Sites Linking In
+
+``` ruby
+client = Awis::Client.new
+sites_linking_in = client.sites_linking_in(url: "site.com")
+```
+
+If you looking for the API request URI:
+
+* Awis::API::SitesLinkingIn.new.load_request_uri(url: 'site.com')
+
+Returns object that contains relationships:
+
+* sites [:title, :url]
+
+You can specify options:
+
+* url
+* count - how many results to retrieve - defaults to max value that is 20
+* start - offset of results - defaults to 0
+
+##### Get Traffic History
+
+``` ruby
+client = Awis::Client.new
+traffic_history = client.traffic_history(url: "site.com")
+```
+
+If you looking for the API request URI:
+
+* Awis::API::TrafficHistory.new.load_request_uri(url: 'site.com')
+
+Returns object that contains methods:
+
+* range
+* site
+* start
+
+Returns object that contains relationships:
+
+* historical_data [:date, :page_views_per_million, :page_views_per_user, :rank, :reach_per_million]
+
+You can specify options:
+
+* url
+* range - how many days to retrieve - defaults to max value 31
+* start - start date (i.e. "20120120", 4.days.ago) - defaults to range number days ago
+
+##### Get Category Listings
+
+``` ruby
+client = Awis::Client.new
+category_listings = client.category_listings(path: "Top/Arts")
+```
+
+If you looking for the API request URI:
+
+* Awis::API::CategoryListings.new.load_request_uri(path: "Top/Games/Card_Games")
+
+Returns object that contains methods:
+
+* count
+* recursive_count
+
+Returns object that contains relationships:
+
+* listings [:data_url, :title, :popularity_rank, :description]
+
+##### Get Category Browse
+
+``` ruby
+client = Awis::Client.new
+category_browses = client.category_browse(path: "Top/Arts")
+```
+
+If you looking for the API request URI:
+
+* Awis::API::CategoryBrowse.new.load_request_uri(path: "Top/Games/Card_Games")
+
+Returns object that contains methods:
+
+* categories [:path, :title, :sub_category_count, :total_listing_count]
+* language_categories [:path, :title, :sub_category_count, :total_listing_count]
+* related_categories [:path, :title, :sub_category_count, :total_listing_count]
+* letter_bars [:path, :title, :sub_category_count, :total_listing_count]
+
+Returns object that contains relationships:
+
+* listings [:data_url, :title, :popularity_rank, :description]
+
+##### How to run test
+
+* rake test
+
+##### Request ID and Status Code
+
+You can retrieve status code and requestID
+
+* request_id
+* status_code
+
+### Parsers
+
+Awis is using `nokogiri` to parse XML documents.
+
+### Contributors
+
+* [Encore Shao](https://github.com/encoreshao)
+
+### Copyright
+
+Copyright (c) Encore Shao. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task default: :test

data/awis.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'awis-sdk-ruby_'
+  spec.version       = Awis::VERSION
+  spec.authors       = ['Encore Shao']
+  spec.email         = ['encore.shao@gmail.com']
+
+  spec.summary       = 'Ruby - Amazon Alexa Web Information Service Library (AWIS)'
+  spec.description   = 'Ruby - Amazon Alexa Web Information Service Library (AWIS)'
+  spec.homepage      = 'https://github.com/encoreshao/amazon-awis'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'aws-sigv4'
+  spec.add_dependency 'multi_xml'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'awis'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/awis.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'multi_xml'
+require 'nokogiri'
+require 'aws-sigv4'
+
+require 'awis/version'
+require 'awis/hash'
+require 'awis/utils'
+require 'awis/exceptions'
+require 'awis/connection'
+require 'awis/config'
+require 'awis/client'
+require 'awis/api'
+require 'awis/models'
+
+module Awis
+  SERVICE_PATH          = 'api'
+  SERVICE_NAME          = 'awis'
+  SERVICE_REGION        = 'us-west-1'
+  SERVICE_HOST          = "#{SERVICE_NAME}.#{SERVICE_REGION}.amazonaws.com"
+end

data/lib/awis/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Awis
+  module API
+    autoload :Base,             'awis/api/base'
+    autoload :UrlInfo,          'awis/api/url_info'
+    autoload :TrafficHistory,   'awis/api/traffic_history'
+    autoload :SitesLinkingIn,   'awis/api/sites_linking_in'
+    autoload :CategoryListings, 'awis/api/category_listings'
+    autoload :CategoryBrowse,   'awis/api/category_browse'
+  end
+end

data/lib/awis/api/base.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Awis
+  module API
+    class Base
+      include Utils::Extra
+      attr_reader :arguments, :response_body
+
+      def fetch(arguments = {})
+        validation_arguments!(arguments)
+
+        loading_response_body
+        self
+      end
+
+      def request_description_params
+        arguments[:descriptions].to_s.capitalize
+      end
+
+      def parsed_body
+        @parsed_body ||= MultiXml.parse(response_body)
+      end
+
+      def loading_response_body
+        @response_body = Awis::Connection.new.get(params)
+      end
+
+      def root_node_name
+        "#{action_name}Response"
+      end
+
+      def action_name
+        self.class.name.split(/\:\:/)[-1]
+      end
+
+      def load_request_uri(params)
+        collection = Awis::Connection.new
+        collection.setup_params(params)
+        collection.uri
+      end
+
+      def before_validation_arguments(arguments)
+        raise ArgumentError, "Invalid arguments. should be like { url: 'site.com' }" unless arguments.is_a?(Hash)
+        raise ArgumentError, 'Invalid arguments. the url must be configured.' unless arguments.key?(:url)
+      end
+
+      class << self
+        def loading_data_from_xml(xml_file_path)
+          MultiXml.parse(File.new(xml_file_path))
+        end
+      end
+    end
+  end
+end