google-amp-cache 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2029c53203e254334b2c265ceeeaebe12ee61e5bccd8ae537910d9eabd24e87
-  data.tar.gz: c7a36a638dc5dc4a71959b58d41977e511c11ca18460327538171467ac9c0ea2
+  metadata.gz: d60a5c719f46fb142aa641de52325d940b9ba48c6163295f75d0a88c6caed5a6
+  data.tar.gz: 675daf604e555c4b55a89dc6c692793cf0f7f40f39bd0204a4660cd5504ef9b6
 SHA512:
-  metadata.gz: ee6b103810ad6dc17b1bf2933906a6b4bd3bcc1efc65d8e55440995728c390bf783a46b5108004d04b3ac6646a9a86bbd37de5ffe67a9e48d7efad8dcd59928c
-  data.tar.gz: ae3693004fec1e4f4b4da2e40f9172af5dd522ced079ae024206a9cd9881fb8ef860c864bce4b8ce3dd3df54ad5d5435d2f9084c484debde297d8dce949ef6a0
+  metadata.gz: e5f412b10a2c525c2a03f60c357aaba64991643102d99844547dfe83c89bfcf10098a40999c3bc129e9192a600fcf6de2580574d0705fbd6a3f7a92654725aa4
+  data.tar.gz: 4203a672620f38fbcd933ca6e09c1964669a6bda1ae33b0f1dd45fa81961cec7689454562d06ced56e75eb8f93008c556a6a49cc2196cab7e912e7592a735c36

data/.gitignore

@@ -1,8 +1,8 @@
 /.bundle/
-/.yardoc
-/_yardoc/
+/Gemfile.lock
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+/private-key.pem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4

data/CHANGELOG.md

@@ -6,8 +6,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## 0.2.0 - 2020-09-17
+
+* Rewrite client to replace HTTParty with Faraday
+* Format Ruby codes
+
 ## 0.1.0 - 2018-06-13
-### Added
 
 * Import the project with initial implementation.
 

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in google-amp-cache.gemspec
 gemspec

data/Rakefile

@@ -1,9 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
-desc "Run tests"
+desc 'Run tests'
 
 task default: :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "google/amp/cache"
+require 'bundler/setup'
+require 'google/amp/cache'
 
 # 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.
@@ -10,5 +11,5 @@ require "google/amp/cache"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/google-amp-cache.gemspec

@@ -1,31 +1,31 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "google/amp/cache/version"
+require 'google/amp/cache/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "google-amp-cache"
+  spec.name          = 'google-amp-cache'
   spec.version       = Google::AMP::Cache::VERSION
-  spec.authors       = ["Richard Lee"]
-  spec.email         = ["rl@polydice.com"]
+  spec.authors       = ['Richard Lee']
+  spec.email         = ['rl@polydice.com']
 
-  spec.summary       = %q{A Ruby wrapper for Google AMP Cache API}
+  spec.summary       = 'A Ruby wrapper for Google AMP Cache API'
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/polydice/google-amp-cache"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/polydice/google-amp-cache'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "multi_json", "~> 1.3"
-  spec.add_runtime_dependency "httparty", ">= 0.7.6"
-  spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_runtime_dependency 'rack'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.3"
-  spec.add_development_dependency "minitest-reporters", "~> 1.2"
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/google/amp/cache.rb

@@ -1,5 +1,4 @@
-require "multi_json"
-require "httparty"
+# frozen_string_literal: true
 
-require "google/amp/cache/version"
-require "google/amp/cache/client"
+require 'google/amp/cache/version'
+require 'google/amp/cache/client'

data/lib/google/amp/cache/client.rb

@@ -1,70 +1,73 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
 require 'base64'
-require 'rack'
 require 'uri'
+require 'openssl'
 
-module Google::AMP::Cache
-  class Client
-    include HTTParty
-    base_uri 'https://acceleratedmobilepageurl.googleapis.com/v1'
+module Google
+  module AMP
+    module Cache
+      class Client
+        UPDATE_CACHE_API_DOMAIN_SUFFIX = 'cdn.ampproject.org'
+        DIGEST = OpenSSL::Digest::SHA256.new
 
-    UPDATE_CACHE_API_DOMAIN_SUFFIX = 'cdn.ampproject.org'
-    DIGEST = OpenSSL::Digest::SHA256.new
+        attr_reader :private_key, :google_api_key
 
-    attr_reader :private_key, :google_api_key
+        def initialize(api_key = nil, private_key = nil)
+          @google_api_key = api_key
+          @private_key = OpenSSL::PKey::RSA.new(private_key) if private_key
+        end
 
-    def initialize(api_key = nil, private_key = nil)
-      @google_api_key = api_key
-      @private_key = OpenSSL::PKey::RSA.new(private_key) if private_key
-    end
+        def batch_get(urls, lookup_strategy = :FETCH_LIVE_DOC)
+          Faraday.new('https://acceleratedmobilepageurl.googleapis.com/',
+                      headers: {
+                        'X-Goog-Api-Key' => google_api_key
+                      }) do |conn|
+            conn.request :json
+            conn.response :json
+            conn.response :raise_error
+          end.post('/v1/ampUrls:batchGet', {
+                     urls: Array(urls),
+                     lookupStrategy: lookup_strategy
+                   }).body
+        end
 
-    def batch_get(urls, lookup_strategy = :FETCH_LIVE_DOC)
-      post('/ampUrls:batchGet',
-        body: {
-          urls: Array(urls),
-          lookupStrategy: lookup_strategy
-        }.to_json,
-        headers: {
-          'Content-Type' => 'application/json',
-          "X-Goog-Api-Key" => google_api_key
-        })
-    end
+        def update_cache(url, content_type = :document)
+          page_uri = URI.parse(url)
+          subdomain = format_domain(page_uri.host)
 
-    def update_cache(url, content_type = :document)
-      page_uri = URI.parse(url)
-      subdomain = format_domain(page_uri.host)
+          path_components = ['update-cache', short_content_type(content_type)]
+          path_components << 's' if page_uri.scheme.match?('https')
+          path_components << "#{page_uri.host}#{page_uri.path}"
+          path = path_components.join('/')
 
-      api_host = URI.parse(["https://", subdomain, '.', UPDATE_CACHE_API_DOMAIN_SUFFIX].join)
-      params = {
-        amp_action: 'flush',
-        amp_ts: Time.now.to_i
-      }
+          params = Faraday::Utils::ParamsHash[{ amp_action: 'flush', amp_ts: Time.now.to_i }]
 
-      api_path = "/update-cache/#{short_content_type(content_type)}/#{'s/' if page_uri.scheme.match?('https')}#{page_uri.host}#{page_uri.path}?#{Rack::Utils.build_query(params)}"
-      sig = private_key.sign(DIGEST, api_path)
-      signature = Base64.urlsafe_encode64(sig)
+          sig = private_key.sign(DIGEST, "/#{path}?#{params.to_query}")
+          params[:amp_url_signature] = Base64.urlsafe_encode64(sig)
 
-      result = self.class.get("#{api_host}#{api_path}&amp_url_signature=#{signature}")
-      result.ok?
-    end
+          Faraday.new("https://#{subdomain}.cdn.ampproject.org/") do |conn|
+            conn.response :raise_error
+          end.get(path, params).body
+        end
 
-    def short_content_type(type)
-      case type.to_sym
-      when :document
-        'c'
-      when :image
-        'i'
-      when :resource
-        'r'
-      end
-    end
-
-    def format_domain(url)
-      url.gsub('-', '--').tr('.', '-')
-    end
+        def short_content_type(type)
+          case type.to_sym
+          when :document
+            'c'
+          when :image
+            'i'
+          when :resource
+            'r'
+          end
+        end
 
-    def post(path, opts={})
-      response = self.class.post(path, opts)
-      response.parsed_response
+        def format_domain(url)
+          url.gsub('-', '--').tr('.', '-')
+        end
+      end
     end
   end
-end
+end

data/lib/google/amp/cache/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Google
   module AMP
     module Cache
-      VERSION = "0.1.0"
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: google-amp-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -53,61 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '13.0'
 description: A Ruby wrapper for Google AMP Cache API
 email:
 - rl@polydice.com
@@ -116,9 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -132,7 +118,7 @@ homepage: https://github.com/polydice/google-amp-cache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for Google AMP Cache API
 test_files: []

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    google-amp-cache (0.1.0)
-      httparty (>= 0.7.6)
-      multi_json (~> 1.3)
-      rack
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    builder (3.2.3)
-    httparty (0.16.2)
-      multi_xml (>= 0.5.2)
-    minitest (5.11.3)
-    minitest-reporters (1.2.0)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    rack (2.0.5)
-    rake (10.5.0)
-    ruby-progressbar (1.9.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  google-amp-cache!
-  minitest (~> 5.3)
-  minitest-reporters (~> 1.2)
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.16.1