akamai-core-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90661e56d46fe43694b6e0bad32137e5872e4cdd
+  data.tar.gz: 43b612ab2bce461c6ccbaa9789a655037915c3c6
+SHA512:
+  metadata.gz: 9b280e973e2e11e7b3c7b5e0a7e8df510d058f76b2c5981078bd4e0351d1a8de565702e2fbd4cad6f9417aaa70c1f31982d26d8ad8b267825efaa875a285c591
+  data.tar.gz: '0978cfd26b119f330aa064d587494fdbd3f84659bcf614692951f73bc0830f793c49c8ef597a4959e40eb98d3e0692a1467652748700ae890207608eb31f3758'

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/client.rb
+/vendor/
+/config/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at satsudai200411078@yahoo.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in akamai-core-client-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akito Ueno
+
+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,82 @@
+# Akamai::Core::Client::Ruby
+This library provides fundamental functions to call Akamai API.  
+Using this library, you can easily request HTTP methods with akamai signature.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'akamai-core-client-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install akamai-core-client-ruby
+
+## Usage
+You can initialize this cient following code.  
+```ruby
+require "akamai/core/client"
+client = Akamai::Core::Client.new(
+  client_secret: "xxxxxxx_secret",
+  host: "akab-host.luna.akamaiapis.net",
+  access_token: "akab-xxxxxxxxx",
+  client_token: "akab-xxxxxxxxx"
+)
+```
+
+### HTTP GET
+```ruby
+response = client.get(
+  "/papi/v0/contracts/"
+)
+response.code # 200
+response.headers # {"server"=>"Apache-Coyote/1.1", "content-language"=>"en-US", "etag"=>"\"xxxxxxxxxe440d81b1a171ca579b2597587\"", "vary"=>"Accept-Encoding", "content-type"=>"text/plain", "date"=>"Sat, 11 Nov 2017 13:39:20 GMT", "connection"=>"keep-alive"}
+response.body["contracts"]["items"].each do |contract|
+  contract # {"contractId"=>"ctr_M-XXXXXX", "contractTypeName"=>"DIRECT_CUSTOMER"}
+end
+```
+
+### HTTP POST
+```ruby
+body = {
+  "cpcodeName" => "SME WAA",
+  "productId" => "prd_Web_App_Accel"
+}
+client.post("/papi/v1/cpcodes?contractId=ctr_1–1TJZFW&groupId=grp_15166", body.to_json)
+```
+
+### HTTP PUT
+```ruby
+body = {
+  "ruleFormat" => "v2015-08-08",
+  "usePrefixes" => "true"
+}
+client.put("/papi/v1/client-settings", body.to_json)
+```
+
+### HTTP HEAD
+```ruby
+client.head("/papi/v1/properties/prp_175780/versions/3/rules?contractId=ctr_1–1TJZFW&groupId=grp_15166&validateRules=true&validateMode=fast&dryRun=true")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/akamai-core-client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/akamai-core-client-ruby.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "akamai/core/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "akamai-core-client"
+  spec.version       = Akamai::Core::Client::VERSION
+  spec.authors       = ["Akito Ueno"]
+  spec.email         = ["satsudai200411078@yahoo.co.jp"]
+
+  spec.summary       = %q{Akamai client}
+  spec.description   = %q{Akamai client. This library provides fundamental function for calling akamai api.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "akamai/core/client/ruby"
+
+# 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/akamai/core/client.rb

@@ -0,0 +1,23 @@
+require "active_support"
+require "active_support/core_ext"
+
+module Akamai
+  module Core
+    module Client
+      autoload :VERSION, "akamai/core/client/version"
+      autoload :Authority, "akamai/core/client/authority"
+      autoload :Client, "akamai/core/client/client"
+      autoload :Error, "akamai/core/client/error"
+      autoload :Response, "akamai/core/client/response"
+
+      class << self
+        def new(host:, client_token:, access_token:, client_secret:, ssl: true)
+          Client.new(
+            host: host, client_token: client_token, access_token: access_token,
+            client_secret: client_secret, ssl: ssl
+          )
+        end
+      end
+    end
+  end
+end

data/lib/akamai/core/client/authority.rb

@@ -0,0 +1,87 @@
+require "openssl"
+require "securerandom"
+
+module Akamai
+  module Core
+    module Client
+      class Authority
+        attr_reader :params, :client 
+        def initialize(params)
+          @params = params.with_indifferent_access
+          @client = @params[:client]
+        end
+
+        def publish_authorization
+          authorization_seed + "signature=#{signature}"  
+        end
+
+        def signature
+          @signature ||= Base64.strict_encode64(
+            OpenSSL::HMAC.digest(OpenSSL::Digest.new("sha256"), encryption_key, encryption_seed)
+          )
+        end
+
+        def authorization_seed
+          "EG1-HMAC-SHA256 " + 
+            [].tap do |arr|
+              %w(client_token access_token).each do |k|
+                arr << "#{k}=#{client.send(k)}"
+              end
+              %w(timestamp nonce).each do |k|
+                arr << "#{k}=#{send(k)}"
+              end
+            end.join(";") + ";"
+        end
+
+        private
+
+        def encryption_key
+          Base64.strict_encode64(
+            OpenSSL::HMAC.digest(OpenSSL::Digest.new("sha256"), client.client_secret, timestamp)
+          )
+        end
+
+        def encryption_seed
+          [].tap do |arr|
+            %w(method protocol host path).each do |k|
+              arr << params[k]
+            end
+            # Although Akamai's document tell us to use header informations in creating signature, "
+            # Probably Akamai use header informations to authenticate api request #
+            # For now I set blank. #
+            arr << ""
+            arr << body_hash
+            arr << authorization_seed 
+          end.join("\t")
+        end
+
+        def body_hash
+          return "" unless params[:body]
+          Base64.strict_encode64(
+            OpenSSL::Digest.new("sha256").digest(params[:body])
+          )
+        end
+
+        def nonce
+          @nonce ||=
+            (params[:nonce] || SecureRandom.uuid)
+        end
+
+        def timestamp
+          @timestamp ||=
+            (params[:timestamp] || Time.now.utc.strftime("%Y%m%dT%H:%M:%S%z"))
+        end
+
+        def canonicalized_headers
+          return "" unless params[:headers]
+          sorted_headers = Hash[params[:headers].sort]
+          [].tap do |arr|
+            sorted_headers.each do |k, v|
+              arr << (k.downcase + ":" + v.to_s.gsub(/\s{2,}/, " "))
+            end
+          end.join("\t")
+        end
+      end
+    end
+  end
+end

data/lib/akamai/core/client/client.rb

@@ -0,0 +1,90 @@
+require "net/http"
+
+module Akamai
+  module Core
+    module Client
+      class Client
+        attr_reader :host, :client_token, :access_token, :client_secret, :ssl
+        def initialize(host:, client_token:, access_token:, client_secret:, ssl: true)
+          @host = host
+          @client_token = client_token
+          @access_token = access_token
+          @client_secret = client_secret
+          @ssl = ssl
+        end
+
+        def get(path, headers = nil)
+          request("get", path, nil, headers)
+        end
+
+        def post(path, body = nil, headers = nil)
+          request("post", path, body, headers)
+        end
+
+        def put(path, body = nil, headers = nil)
+          request("put", path, body, headers)
+        end
+
+        def patch(path, body = nil, headers = nil)
+          request("patch", path, body, headers)
+        end
+
+        def delete(path, headers = nil)
+          request("delete", path, nil, headers)
+        end
+
+        def head(path, headers = nil)
+          request("head", path, nil, headers)
+        end
+
+        private
+
+        def request(method, path, body = nil, optional_headers = nil)
+          response = Response.new(
+            "".tap do |raw_response|
+              http_client.start do |session|
+                headers = {
+                  "Authorization" => authorization(method, path, body,
+                                                   optional_headers),
+                  "Content-Type" => "application/json"
+                }.merge(optional_headers ? optional_headers : {})
+                raw_response = if /^get$|^delete$|^head$/ =~ method
+                                 session.send(method, path, headers)
+                               else
+                                 session.send(method, path, body, headers)
+                               end
+              end
+              break raw_response
+            end
+          )
+
+          Error.new(response.body).tap do |error|
+            error.raise_error if error.exist?
+          end
+          response
+        end
+
+        def http_client
+          @http_client ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
+            http.use_ssl = !!ssl
+          end
+        end
+
+        def protocol
+          ssl ? "https" : "http"
+        end
+
+        def authorization(method, path, body = nil, headers = nil)
+          Authority.new(
+            client: self, method: method.upcase, protocol: protocol,
+            host: host, path: path, body: body, headers: headers
+          ).publish_authorization
+        end
+
+        def uri
+          @uri ||= URI("#{protocol}://#{host}")
+        end
+      end
+    end
+  end
+end

data/lib/akamai/core/client/error.rb

@@ -0,0 +1,35 @@
+module Akamai
+  module Core
+    module Client
+      class Error
+        AkamaiError = Class.new(StandardError)
+        attr_reader :body
+        def initialize(body)
+          @body = /Array/ =~ body.class.name ? body[0] : body
+        end
+
+        def exist?
+          !!message
+        end
+
+        def raise_error
+          raise(AkamaiError, message) if exist?
+        end
+
+        private
+
+        def message
+          @message ||=
+            case body.class.name
+            when /Hash/
+              if body[:errorString]
+                body[:errorString]
+              elsif body[:status] && /^4\d{2}|^5\d{2}/ =~ body[:status].to_s
+                body[:detail]
+              end
+            end
+        end
+      end
+    end
+  end
+end

data/lib/akamai/core/client/response.rb

@@ -0,0 +1,54 @@
+module Akamai
+  module Core
+    module Client
+      class Response
+        attr_reader :http_response
+        def initialize(http_response)
+          @http_response = http_response
+        end
+
+        def body
+          @body ||= if http_response.body
+            JSON.parse(http_response.body).tap do |parsed_body|
+              result =
+                if /^Array$/ =~ parsed_body.class.name
+                  [].tap do |arr|
+                    parsed_body.each do |data|
+                      arr << transform_data(data)
+                    end
+                  end
+                else
+                  transform_data(parsed_body)
+                end
+                break result
+            end
+          end
+        end
+
+        def code
+          http_response.code.to_i
+        end
+
+        def headers
+          @headers ||=
+            {}.tap do |hash|
+              http_response.header.each do |k, v|
+                hash[k] = v
+              end
+            end
+        end
+
+        private
+
+        def body_object
+          JSON.parse(http_response.body)
+        end
+
+        def transform_data(data)
+          return data.with_indifferent_access if /Hash/ =~ data.class.name
+          data
+        end
+      end
+    end
+  end
+end

data/lib/akamai/core/client/version.rb

@@ -0,0 +1,7 @@
+module Akamai
+  module Core
+    module Client
+      VERSION = "0.0.2".freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: akamai-core-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Akito Ueno
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Akamai client. This library provides fundamental function for calling
+  akamai api.
+email:
+- satsudai200411078@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- akamai-core-client-ruby.gemspec
+- bin/console
+- bin/setup
+- lib/akamai/core/client.rb
+- lib/akamai/core/client/authority.rb
+- lib/akamai/core/client/client.rb
+- lib/akamai/core/client/error.rb
+- lib/akamai/core/client/response.rb
+- lib/akamai/core/client/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Akamai client
+test_files: []