google-amp-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2029c53203e254334b2c265ceeeaebe12ee61e5bccd8ae537910d9eabd24e87
+  data.tar.gz: c7a36a638dc5dc4a71959b58d41977e511c11ca18460327538171467ac9c0ea2
+SHA512:
+  metadata.gz: ee6b103810ad6dc17b1bf2933906a6b4bd3bcc1efc65d8e55440995728c390bf783a46b5108004d04b3ac6646a9a86bbd37de5ffe67a9e48d7efad8dcd59928c
+  data.tar.gz: ae3693004fec1e4f4b4da2e40f9172af5dd522ced079ae024206a9cd9881fb8ef860c864bce4b8ce3dd3df54ad5d5435d2f9084c484debde297d8dce949ef6a0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 0.1.0 - 2018-06-13
+### Added
+
+* Import the project with initial implementation.
+
+[Unreleased]: https://github.com/polydice/google-amp-cache/compare/v0.1.0...HEAD

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Polydice, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# google-amp-cache
+
+A simple Ruby API wrapper for [Google AMP Cache](https://developers.google.com/amp/cache/).
+
+## Usage
+
+Create API client using Google API key:
+
+```ruby
+client = Google::AMP::Cache::Client.new MY_GOOGLE_API_KEY, File.read(MY_PRIVATE_KEY)
+```
+
+
+### Update cache
+
+Just simply:
+
+```ruby
+client.update_cache('https://limitless-tundra-65881.herokuapp.com/amp-access/sample/0')
+```
+
+### Match URLs to AMP URLs
+
+You can query AMP URLs from Google AMP Cache:
+
+```ruby
+client.batch_get("https://www.theguardian.com/membership/2016/feb/24/todays-release-of-accelerated-mobile-pages-amp")
+# => {"ampUrls"=>[{"originalUrl"=>"https://www.theguardian.com/membership/2016/feb/24/todays-release-of-accelerated-mobile-pages-amp", "ampUrl"=>"https://amp.theguardian.com/membership/2016/feb/24/todays-release-of-accelerated-mobile-pages-amp", "cdnAmpUrl"=>"https://amp-theguardian-com.cdn.ampproject.org/c/s/amp.theguardian.com/membership/2016/feb/24/todays-release-of-accelerated-mobile-pages-amp"}]}
+```
+
+Or multiple URLs:
+
+```ruby
+client.batch_get(["URL A", "URL B"])
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (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/google-amp-cache.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "google/amp/cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-amp-cache"
+  spec.version       = Google::AMP::Cache::VERSION
+  spec.authors       = ["Richard Lee"]
+  spec.email         = ["rl@polydice.com"]
+
+  spec.summary       = %q{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.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.add_runtime_dependency "multi_json", "~> 1.3"
+  spec.add_runtime_dependency "httparty", ">= 0.7.6"
+  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"
+end

data/lib/google/amp/cache.rb

@@ -0,0 +1,5 @@
+require "multi_json"
+require "httparty"
+
+require "google/amp/cache/version"
+require "google/amp/cache/client"

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

@@ -0,0 +1,70 @@
+require 'base64'
+require 'rack'
+require 'uri'
+
+module Google::AMP::Cache
+  class Client
+    include HTTParty
+    base_uri 'https://acceleratedmobilepageurl.googleapis.com/v1'
+
+    UPDATE_CACHE_API_DOMAIN_SUFFIX = 'cdn.ampproject.org'
+    DIGEST = OpenSSL::Digest::SHA256.new
+
+    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 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)
+
+      api_host = URI.parse(["https://", subdomain, '.', UPDATE_CACHE_API_DOMAIN_SUFFIX].join)
+      params = {
+        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)
+
+      result = self.class.get("#{api_host}#{api_path}&amp_url_signature=#{signature}")
+      result.ok?
+    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 post(path, opts={})
+      response = self.class.post(path, opts)
+      response.parsed_response
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Google
+  module AMP
+    module Cache
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: google-amp-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A Ruby wrapper for Google AMP Cache API
+email:
+- rl@polydice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google-amp-cache.gemspec
+- lib/google/amp/cache.rb
+- lib/google/amp/cache/client.rb
+- lib/google/amp/cache/version.rb
+homepage: https://github.com/polydice/google-amp-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Google AMP Cache API
+test_files: []