akamai-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0871748bba8072e0eec602fc2908961e6dce4f3
+  data.tar.gz: c0647d6f512fc33025e5be94777991d9d33f4e34
+SHA512:
+  metadata.gz: ee495369cfaa6e03b104117771b4d33df42877af0847082f264dd69703627a11ce504eb7b49c1355818dea3bd96a7512b68b8880895356c3403b9a410f91e052
+  data.tar.gz: ddf2bb738a142b7b7e521db69edcb69eab2897d03ef7a58cbb85d1adf8eaeef04f914f74a58fc7581c868c302668f6e1b7c98bd05c080f60a31bf0ce0c66ae5e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in akamai-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,70 @@
+# Akamai::Client::Ruby
+This ruby library is for severarl akamai services.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'akamai-client-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install akamai-client-ruby
+
+## Usage
+### PAPI
+When you want to call PAPI API, you can do it by executing like following code.  
+```
+require "akamai/client"
+
+# Initialize papi client
+client = Akamai::Client::Papi.new(
+  host: "akab-xxxxxx-yyyyy.luna.akamaiapis.net",
+  client_token: "akab-xxxx-yyyyy",
+  client_secret: "XXXX1111222",
+  access_token: "akab-xxxxx-yyyyy"
+)
+
+# List groups
+client.list_groups
+
+# List properties
+client.list_properties(
+  contract_id,
+  group_id
+)
+
+# Get Rule tree
+client.get_rule_tree(
+  property_id,
+  version,
+  contract_id,
+  group_id
+)
+```
+
+Regarding to detail of PAPI API provided by Akamai, please refer https://developer.akamai.com/api/luna/papi/resources.html.
+
+## 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-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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Akamai::Client::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/akamai-client-ruby/blob/master/CODE_OF_CONDUCT.md).

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-client.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "akamai/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "akamai-client"
+  spec.version       = Akamai::Client::VERSION
+  spec.authors       = ["Akito Ueno"]
+  spec.email         = ["akito.ueno@fastretailing.com"]
+
+  spec.summary       = %q{Akamai client for several services.}
+  spec.description   = %q{Akamai basic client for several services, mainly papi.}
+  spec.homepage      = "https://github.com/akitoueno-fr/akamai-client-ruby"
+  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 "akamai-core-client", "~> 0.0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  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/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/client.rb

@@ -0,0 +1,10 @@
+require "akamai/client/version"
+
+module Akamai
+  module Client
+    autoload :VERSION, "akamai/client/version"
+    autoload :Base, "akamai/client/base"
+    autoload :Papi, "akamai/client/papi"
+    autoload :Ccu, "akamai/client/ccu"
+  end
+end

data/lib/akamai/client/base.rb

@@ -0,0 +1,78 @@
+require "akamai/core/client"
+
+module Akamai
+  module Client
+    class Base
+      attr_reader :client
+      def initialize(host:, client_token:, access_token:, client_secret:)
+        @client = Akamai::Core::Client.new(
+          host: host,
+          client_token: client_token,
+          access_token: access_token,
+          client_secret: client_secret
+        )
+      end
+
+      %i(get head).each do |method|
+        define_method(method) do |resource_name, query_params = {}, headers = {}|
+          path = build_full_path(resource_name, query_params)
+          response = client.send(method, path, headers)
+          return response.body if :head == method
+          item_key = if /^[a-z1-9]+-[a-z1-9]+$/ =~ resource_name.to_s.split("/")[0]
+                       resource_name.to_s.split("/")[0].gsub(/-/, "_").camelize(:lower)
+                     else
+                       resource_name.to_s.split("/")[0]
+                     end
+          transform_to_snakecase(
+            response.body[item_key][:items]
+          )
+        end
+      end
+
+      %i(post put patch).each do |method|
+        define_method(method) do |resource_name, body, query_params = {}, headers = {}|
+          path = build_full_path(resource_name, query_params)
+          client.send(method, path, body, headers)
+        end
+      end
+
+      private
+
+      def build_full_path(resource_name, query_params = {})
+        path = URI(File.join(base_path, resource_name.to_s).gsub(/\/$/, ""))
+        params = {}.tap do |hash|
+          query_params.each do |k, v|
+            hash[k.to_s.camelize(:lower)] = v
+          end
+        end
+        path.query = params.present? ? params.to_param : nil
+        path.to_s
+      end
+
+      def transform_to_snakecase(data)
+        if "Array" == data.class.name
+          [].tap do |arr|
+            data.each do |element|
+              arr << transform_hash(element)
+            end
+            break arr
+          end
+        else
+          transform_hash(element)
+        end
+      end
+
+      def transform_hash(element)
+        {}.tap do |hash|
+          element.each do |k, v|
+            hash[k.underscore] = v
+          end
+        end.with_indifferent_access
+      end
+
+      def base_path
+        raise(NotImplementedError, "plase override in subclass")
+      end
+    end
+  end
+end

data/lib/akamai/client/ccu.rb

@@ -0,0 +1,59 @@
+require "akamai/client/base"
+
+module Akamai
+  module Client
+    class Ccu < Base
+      def invalidate_cache_by_url(network, targets)
+        post(
+          "invalidate/url/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def invalidate_cache_by_cp_code(network, targets)
+        post(
+          "invalidate/cpcode/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def invalidate_cache_by_tag(network, targets)
+        post(
+          "invalidate/tag/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def delete_cache_by_url(network, targets)
+        post(
+          "delete/url/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def delete_cache_by_cp_code(network, targets)
+        post(
+          "delete/cpcode/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def delete_cache_by_tag(network, targets)
+        post(
+          "delete/tag/#{network}",
+          build_body(targets) 
+        )
+      end
+
+      def build_body(targets)
+        {
+          objects: targets
+        }.to_json
+      end
+
+      def base_path
+        "/ccu/v3"
+      end
+    end
+  end
+end

data/lib/akamai/client/papi.rb

@@ -0,0 +1,66 @@
+require "akamai/client/base"
+
+module Akamai
+  module Client
+    class Papi < Base
+      def list_groups
+        get(:groups)
+      end
+
+      def list_contracts
+        get(:contracts)
+      end
+
+      def list_custom_behaviors
+        get("custom-behaviors")
+      end
+
+      def list_products(contract_id)
+        get(:products, {contract_id: contract_id})
+      end
+
+      def list_cp_codes(contract_id, group_id)
+        get(
+          :cpcodes,
+          {contract_id: contract_id, group_id: group_id} 
+        )
+      end
+
+      def list_properties(contract_id, group_id)
+        get(
+          :properties,
+          {contract_id: contract_id, group_id: group_id} 
+        )
+      end
+
+      def get_property(property_id, contract_id, group_id)
+        get(
+          "properties/#{property_id}",
+          {contract_id: contract_id, group_id: group_id} 
+        )
+      end
+
+      def get_rule_tree(property_id, version, contract_id, group_id, options = {})
+        path = build_full_path(
+          "properties/#{property_id}/versions/#{version}/rules",
+          {contract_id: contract_id, group_id: group_id}.merge(options)
+        )
+        response = client.get(path)
+        transform_to_snakecase(
+          response.body[:rules][:behaviors]
+        )
+      end
+
+      def get_custom_behavior(behavior_id)
+        get(
+          :custom-behaviors,
+          {behavior_id: behavior_id}
+        )
+      end
+
+      def base_path
+        "/papi/v1"
+      end
+    end
+  end
+end

data/lib/akamai/client/version.rb

@@ -0,0 +1,5 @@
+module Akamai
+  module Client
+    VERSION = "0.0.1".freeze
+  end
+end

data/samples/ccu.rb

@@ -0,0 +1,12 @@
+require "akamai/client"
+
+# This sample provide how to purge urls specified 
+
+ccu_client = Akamai::Client::Ccu.new(
+  host: "akab-xxxx-yyyy.purge.akamaiapis.net",
+  client_token: "akab-xxxx-yyyy",
+  client_secret: "XXXXyyzz",
+  access_token: "akab-xxxx-yyyy"
+)
+targets = ["https://akamai.sample.net/sp/"]
+ccu_client.delete_cache_by_url("staging", targets)

data/samples/papi.rb

@@ -0,0 +1,29 @@
+require "akamai/client"
+require "akamai/core/client/error"
+
+# This sample provide how to get all rule of properties which you can get. 
+
+client = Akamai::Client::Papi.new(
+  host: "akab-xxxx-yyyy.luna.akamaiapis.net",
+  client_token: "akab-xxxx-yyyy",
+  client_secret: "XXXXyyzz",
+  access_token: "akab-xxxx-yyyy"
+)
+properties = []
+client.list_groups.each do |group|
+  if group[:contract_ids]
+    begin
+      properties += client.list_properties(group[:contract_ids][0], group[:group_id])
+    rescue Akamai::Core::Client::Error::AkamaiError
+      next
+    end
+  end
+end
+properties.each do |property|
+  client.get_rule_tree(
+    property[:property_id],
+    property[:latest_version],
+    property[:contract_id],
+    property[:group_id]
+  )
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: akamai-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akito Ueno
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: akamai-core-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !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: 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 basic client for several services, mainly papi.
+email:
+- akito.ueno@fastretailing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- akamai-client.gemspec
+- bin/console
+- bin/setup
+- lib/akamai/client.rb
+- lib/akamai/client/base.rb
+- lib/akamai/client/ccu.rb
+- lib/akamai/client/papi.rb
+- lib/akamai/client/version.rb
+- samples/ccu.rb
+- samples/papi.rb
+homepage: https://github.com/akitoueno-fr/akamai-client-ruby
+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 for several services.
+test_files: []