3scale_toolbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2041609888563be7ca7b60bbd7cdb6ddd8f60911
+  data.tar.gz: 417e59c876b5111b84af2472ca3df9e51dd1f4e8
+SHA512:
+  metadata.gz: 7ffdb592223d2a9bf649bba41c8984d63b13c27863fb146a73623a98b561a62bc56f3ae4544dd9679fa8ffa65c782b5dbf4baebcdc826272ef65a059e36c1eea
+  data.tar.gz: 47750f59a33e3839b0e4cfa3b2005b247a20f4476029ea3e546d34290dca615d0406c466e2109fff9f04e591917ac0a0e38d00163372a02bd35bc1b8ee8a1d4c

data/README.md

@@ -0,0 +1,35 @@
+# 3scale toolbox
+
+3scale toolbox is a set of tools to help you manage your 3scale product. 
+
+## Installation
+
+
+Install the CLI:
+
+    $ gem install 3scale_toolbox
+
+## Usage
+
+```shell
+3scale help
+```
+
+### Copy a service
+
+Will create a new service, copy existing methods, metrics, application plans and their usage limits.
+
+```shell
+3scale copy service NUMBER --endpoint=https://foo-admin.3scale.net --provider-key=your-key
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec threescale_toolbox` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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/3scale/3scale_toolbox.
+

data/exe/3scale

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require '3scale_toolbox/cli'
+
+options, argv = ThreeScaleToolbox::CLI.parse
+
+unless options.command
+  puts 'Available subcommands: '
+  puts ThreeScaleToolbox::CLI.subcommands
+  puts
+  ThreeScaleToolbox::CLI.print_help!
+end
+
+exec options.command.full_path, *ARGV

data/exe/3scale-copy

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require '3scale_toolbox/cli'
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |parser|
+  parser.banner = '3scale copy <command> [options]'
+
+  parser.on('-e', '--endpoint ENDPOINT', "Endpoint") do |domain|
+    options[:endpoint] = domain
+  end
+
+  parser.on('-p', '--provider-key PROVIDER_KEY', "Provider Key") do |provider_key|
+    options[:provider_key] = provider_key
+  end
+
+  parser.on('-h', '--help', 'Prints this help') do
+    puts parser
+    exit
+  end
+end.parse!
+
+endpoint = options.fetch(:endpoint) { raise OptionParser::MissingArgument, 'endpoint' }
+provider_key = options.fetch(:provider_key) { raise OptionParser::MissingArgument, 'provider_key' }
+
+require '3scale/api'
+
+client = ThreeScale::API.new(endpoint: endpoint, provider_key: provider_key)
+
+case (command = ARGV.shift)
+  when 'service'
+    service_id = ARGV.shift or raise OptionParser::MissingArgument, 'service_id'
+
+    service = client.show_service(service_id)
+
+    name = "#{service['name']} (copy)"
+
+    copy = client.list_services.find do |service|
+      service['name'] == name
+    end
+
+    copy ||= client.create_service(name: name,
+                                   end_user_registration_required: service['end_user_registration_required'])
+    service_copy_id = copy.fetch('id')
+
+    puts "new service id #{service_copy_id}"
+
+    metrics = client.list_metrics(service_id)
+    metrics_copies = client.list_metrics(service_copy_id)
+
+    hits = metrics.find{ |metric| metric['system_name'] == 'hits' } or raise 'missing hits metric'
+    hits_copy = metrics_copies.find{ |metric| metric['system_name'] == 'hits' } or raise 'missing hits metric'
+
+    methods = client.list_methods(service_id, hits['id'])
+    methods_copies = client.list_methods(service_copy_id, hits_copy['id'])
+
+    puts "original service hits metric #{hits['id']} has #{methods.size} methods"
+    puts "copied service hits metric #{hits_copy['id']} has #{methods_copies.size} methods"
+
+    missing_methods = methods.reject { |method|  methods_copies.find{|copy| method.fetch('system_name') == copy.fetch('system_name') } }
+
+    puts "creating #{missing_methods.size} missing methods on copied service"
+
+    missing_methods.each do |method|
+      copy = { friendly_name: method['friendly_name'], system_name: method['system_name'] }
+      client.create_method(service_copy_id, hits_copy['id'], copy)
+    end
+
+    metrics_copies = client.list_metrics(service_copy_id)
+
+    puts "original service has #{metrics.size} metrics"
+    puts "copied service has #{metrics.size} metrics"
+
+    missing_metrics = metrics.reject { |metric| metrics_copies.find{|copy| metric.fetch('system_name') == copy.fetch('system_name') } }
+
+    missing_metrics.map do |metric|
+      metric.delete('links')
+      client.create_metric(service_copy_id, metric)
+    end
+
+    puts "created #{missing_metrics.size} metrics on the copied service"
+
+    plans = client.list_service_application_plans(service_id)
+    plan_copies = client.list_service_application_plans(service_copy_id)
+
+    puts "original service has #{plans.size} application plans "
+    puts "copied service has #{plan_copies.size} application plans"
+
+    missing_application_plans = plans.reject { |plan| plan_copies.find{|copy| plan.fetch('system_name') == copy.fetch('system_name') } }
+
+    puts "copied service missing #{missing_application_plans.size} application plans"
+
+    missing_application_plans.each do |plan|
+      plan.delete('links')
+      plan.delete('default') # TODO: handle default plan
+
+      if plan.delete('custom') # TODO: what to do with custom plans?
+        puts "skipping custom plan #{plan}"
+      else
+        client.create_application_plan(service_copy_id, plan)
+      end
+    end
+
+    application_plan_mapping = client.list_service_application_plans(service_copy_id).map do |plan_copy|
+      plan = plans.find{|plan| plan.fetch('system_name') == plan_copy.fetch('system_name') }
+
+      [plan['id'], plan_copy['id']]
+    end
+
+
+    metrics_mapping = client.list_metrics(service_copy_id).map do |copy|
+      metric = metrics.find{|metric| metric.fetch('system_name') == copy.fetch('system_name') }
+
+      [metric['id'], copy['id']]
+    end.to_h
+
+    application_plan_mapping.each do |original_id, copy_id|
+      limits = client.list_application_plan_limits(original_id)
+      limits_copy = client.list_application_plan_limits(copy_id)
+
+      missing_limits = limits.reject { |limit| limits_copy.find{|limit_copy| limit.fetch('period') == limit_copy.fetch('period') } }
+
+      missing_limits.each do |limit|
+        limit.delete('links')
+        client.create_application_plan_limit(copy_id, metrics_mapping.fetch(limit.fetch('metric_id')), limit)
+      end
+      puts "copied application plan #{copy_id} is missing #{missing_limits.size} from the original plan #{original_id}"
+    end
+
+
+
+  else
+
+end

data/exe/3scale-help

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require '3scale_toolbox/cli'
+
+puts '3scale toolbox help'
+puts
+
+puts 'Available subcommands: '
+puts ThreeScaleToolbox::CLI.subcommands.map(&:name)

data/lib/3scale_toolbox.rb

@@ -0,0 +1,5 @@
+require '3scale_toolbox/version'
+
+module ThreeScaleToolbox
+  # Your code goes here...
+end

data/lib/3scale_toolbox/cli.rb

@@ -0,0 +1,78 @@
+require 'optparse'
+
+module ThreeScaleToolbox
+  module CLI
+    Options = Struct.new(:command)
+
+    class Parser
+      def self.parse(options)
+        args = Options.new(nil)
+
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = "Usage: 3scale <command> [options]"
+
+
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+        end
+
+        begin
+          opt_parser.order!(options)
+        rescue OptionParser::InvalidOption => e
+          p e
+        end
+
+        return args
+      end
+    end
+
+    def self.parse(argv = ARGV)
+      options = Parser.parse(argv)
+      options.command = argv.shift
+      options.command = subcommands.find { |subcommand| subcommand.name == options.command }
+
+      [ options, argv ]
+    end
+
+    def self.print_help!
+      Parser.parse %w[--help]
+    end
+
+    def self.plugins
+      Gem.loaded_specs.select{ |name, _| name.start_with?('3scale') }.values
+    end
+
+    def self.current_command
+      File.expand_path($0, Dir.pwd)
+    end
+
+    def self.subcommands
+      plugins
+          .flat_map { |spec| spec.executables.flat_map{ |bin| Subcommand.new(bin, spec) } }
+          .reject { |subcommand| subcommand.full_path == current_command || subcommand.name.nil? }
+    end
+
+    class Subcommand
+      attr_reader :executable, :spec
+
+      def initialize(executable, spec)
+        @executable = executable
+        @spec = spec
+      end
+
+      def to_s
+        name
+      end
+
+      def name
+        executable.split('-', 2)[1]
+      end
+
+      def full_path
+        spec.bin_file(executable)
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/version.rb

@@ -0,0 +1,3 @@
+module ThreeScaleToolbox
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: 3scale_toolbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Cichra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 3scale-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 3scale CLI tools to manage your API from the terminal.
+email:
+- michal@3scale.net
+executables:
+- 3scale
+- 3scale-copy
+- 3scale-help
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/3scale
+- exe/3scale-copy
+- exe/3scale-help
+- lib/3scale_toolbox.rb
+- lib/3scale_toolbox/cli.rb
+- lib/3scale_toolbox/version.rb
+homepage: https://github.com/3scale/3scale_toolbox
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: 3scale CLI Toolbox.
+test_files: []
+has_rdoc: