3scale_toolbox 0.4.0 → 0.5.0

data/lib/3scale_toolbox/commands/update_command.rb

@@ -0,0 +1,20 @@
+require 'cri'
+require '3scale_toolbox/base_command'
+require '3scale_toolbox/commands/update_command/update_service'
+
+module ThreeScaleToolbox
+  module Commands
+    module UpdateCommand
+      extend ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'update'
+          usage       'update <command> [options]'
+          summary     '3scale update command'
+          description '3scale update command.'
+        end
+      end
+      add_subcommand(UpdateServiceSubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands.rb

@@ -0,0 +1,24 @@
+require '3scale_toolbox/commands/3scale_command'
+require '3scale_toolbox/commands/help_command'
+require '3scale_toolbox/commands/copy_command'
+require '3scale_toolbox/commands/import_command'
+require '3scale_toolbox/commands/update_command'
+
+module ThreeScaleToolbox
+  module Commands
+    BUILTIN_COMMANDS = [ # :nodoc:
+      ThreeScaleToolbox::Commands::HelpCommand,
+      ThreeScaleToolbox::Commands::CopyCommand,
+      ThreeScaleToolbox::Commands::ImportCommand,
+      ThreeScaleToolbox::Commands::UpdateCommand
+    ].freeze
+
+    def self.service_valid_params
+      %w[
+        name backend_version deployment_option description
+        system_name end_user_registration_required
+        support_email tech_support_email admin_support_email
+      ]
+    end
+  end
+end

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/3scale_toolbox.rb

@@ -1,5 +1,9 @@
-require '3scale_toolbox/version'
-
 module ThreeScaleToolbox
-  # Your code goes here...
+  def self.load_plugins
+    plugin_paths.each { |plugin_path| require plugin_path }
+  end
+
+  def self.plugin_paths
+    Gem.find_files('3scale_toolbox_plugin')
+  end
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michal Cichra
+- Eguzki Astiz Lezaun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-10-25 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,40 +39,71 @@ dependencies:
     - - "~>"
       - !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: 3scale-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: cri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '2.10'
 description: 3scale CLI tools to manage your API from the terminal.
 email:
 - michal@3scale.net
+- eastizle@redhat.com
 executables:
 - 3scale
-- 3scale-copy
-- 3scale-help
-- 3scale-import
-- 3scale-update
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - exe/3scale
-- exe/3scale-copy
-- exe/3scale-help
-- exe/3scale-import
-- exe/3scale-update
 - lib/3scale_toolbox.rb
+- lib/3scale_toolbox/base_command.rb
 - lib/3scale_toolbox/cli.rb
+- lib/3scale_toolbox/commands.rb
+- lib/3scale_toolbox/commands/3scale_command.rb
+- lib/3scale_toolbox/commands/copy_command.rb
+- lib/3scale_toolbox/commands/copy_command/copy_service.rb
+- lib/3scale_toolbox/commands/help_command.rb
+- lib/3scale_toolbox/commands/import_command.rb
+- lib/3scale_toolbox/commands/import_command/import_csv.rb
+- lib/3scale_toolbox/commands/update_command.rb
+- lib/3scale_toolbox/commands/update_command/update_service.rb
 - lib/3scale_toolbox/version.rb
 homepage: https://github.com/3scale/3scale_toolbox
 licenses:
@@ -93,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 3scale CLI Toolbox.

data/exe/3scale-copy

@@ -1,222 +0,0 @@
-#!/usr/bin/env ruby
-
-require '3scale_toolbox/cli'
-
-require 'optparse'
-
-options = {}
-
-parser = OptionParser.new do |parser|
-  parser.banner = '3scale copy <command> [options]'
-
-  parser.on('-s', '--source SOURCE', "Source") do |domain|
-    options[:source] = domain
-  end
-
-  parser.on('-d', '--destination DESTINATION', "Destination") do |domain|
-    options[:destination] = domain
-  end
-
-  parser.on('-t', '--target-system-name TARGET_SYSTEM_NAME', 'Target system name') do |name|
-    options[:target_system_name] = name
-  end
-
-  parser.on('-h', '--help', 'Prints this help') do
-    puts parser
-    puts
-    puts 'Available Commands:', ['service <service_id>', 'help']
-    exit
-  end
-end
-
-print_help = ->(error = nil) do
-  if error
-    puts "Error: #{error}"
-    puts
-  end
-  parser.parse(['--help'])
-end
-
-
-parser.parse!
-
-def compare_hashes(first, second, keys)
-  keys.map{ |key| first.fetch(key) } == keys.map{ |key| second.fetch(key) }
-end
-
-def fetch_option(options, key)
-  options.fetch(key) { raise OptionParser::MissingArgument, key }
-end
-
-def provider_key_from_url(url)
-  url[/\w*@/][0..-2]
-end
-
-def endpoint_from_url(url)
-  url.sub /\w*@/, ''
-end
-
-def copy_service_params(original, system_name)
-  {
-    name:        original['name'],
-    system_name: system_name,
-    backend_version: original['backend_version'],
-    end_user_registration_required: original['end_user_registration_required']
-  }.reject { |key, value| !value }
-end
-
-case (command = ARGV.shift)
-  when 'service'
-    source      = fetch_option options, :source
-    destination = fetch_option options, :destination
-    system_name = options[:target_system_name]
-    
-    require '3scale/api'
-
-    service_id = ARGV.shift or raise OptionParser::MissingArgument, 'service_id'
-
-    source_client = ThreeScale::API.new(
-      endpoint:     endpoint_from_url(source), 
-      provider_key: provider_key_from_url(source)
-    )
-    client        = ThreeScale::API.new(
-      endpoint:     endpoint_from_url(destination), 
-      provider_key: provider_key_from_url(destination)
-    )
-    
-    service = source_client.show_service(service_id)
-    copy    = client.create_service(copy_service_params(service, system_name))
-
-    raise "Service has not been saved. Errors: #{copy['errors']}" unless copy['errors'].nil?
-
-    service_copy_id = copy.fetch('id')
-
-    puts "new service id #{service_copy_id}"
-
-    proxy = source_client.show_proxy(service_id)
-    client.update_proxy(service_copy_id, proxy)
-    puts "updated proxy of #{service_copy_id} to match the original"
-
-    metrics = source_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 = source_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| compare_hashes(method, copy, ['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_copies.size} metrics"
-
-    missing_metrics = metrics.reject { |metric| metrics_copies.find{|copy| compare_hashes(metric, copy, ['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 = source_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 ||= {}
-
-      [metric['id'], copy['id']]
-    end.to_h
-
-    puts "destroying all mapping rules of the copy which have been created by default"
-    client.list_mapping_rules(service_copy_id).each do |mapping_rule|
-      client.delete_mapping_rule(service_copy_id, mapping_rule['id'])
-    end
-
-    mapping_rules = source_client.list_mapping_rules(service_id)
-    mapping_rules_copy = client.list_mapping_rules(service_copy_id)
-
-    puts "the original service has #{mapping_rules.size} mapping rules"
-    puts "the copy has #{mapping_rules_copy.size} mapping rules"
-
-    unique_mapping_rules_copy = mapping_rules_copy.dup
-
-    missing_mapping_rules = mapping_rules.reject do |mapping_rule|
-      matching_metric = unique_mapping_rules_copy.find do |copy|
-        compare_hashes(mapping_rule, copy, %w(pattern http_method delta)) &&
-            metrics_mapping.fetch(mapping_rule.fetch('metric_id')) == copy.fetch('metric_id')
-      end
-
-      unique_mapping_rules_copy.delete(matching_metric)
-    end
-
-    puts "missing #{missing_mapping_rules.size} mapping rules"
-
-    missing_mapping_rules.each do |mapping_rule|
-      mapping_rule.delete('links')
-      mapping_rule['metric_id'] = metrics_mapping.fetch(mapping_rule.delete('metric_id'))
-      client.create_mapping_rule(service_copy_id, mapping_rule)
-    end
-    puts "created #{missing_mapping_rules.size} mapping rules"
-
-    puts "extra #{unique_mapping_rules_copy.size} mapping rules"
-    puts unique_mapping_rules_copy.each{|rule| rule.delete('links') }
-
-    application_plan_mapping.each do |original_id, copy_id|
-      limits = source_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
-  when 'help'
-    print_help.call
-  when nil
-    print_help.call("missing subcommand")
-  else
-    print_help.call("unknown command #{command}")
-end

data/exe/3scale-help

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

data/exe/3scale-import

@@ -1,178 +0,0 @@
-#!/usr/bin/env ruby
-
-require '3scale_toolbox/cli'
-require 'optparse'
-require '3scale/api'
-require 'uri'
-require 'csv'
-
-options = {}
-
-parser = OptionParser.new do |parser|
-  parser.banner = '3scale import <command> [options]'
-
-  parser.on('-d', '--destination DESTINATION') do |domain|
-    options[:destination] = domain
-  end
-
-  parser.on('-f', '--file FILE') do |file|
-    options[:file] = file
-  end
-
-  parser.on('-h', '--help', 'Prints this help') do
-    puts parser
-    puts 
-    puts 'Available Commands:', ['csv', 'help']
-    exit
-  end
-end
-
-print_help = ->(error = nil) do
-  if error
-    puts "Error: #{error}"
-    puts
-  end
-  parser.parse(['--help'])
-end
-
-parser.parse!
-
-def fetch_option(options, key)
-  options.fetch(key) { raise OptionParser::MissingArgument, key }
-end
-
-def provider_key_from_url(url)
-  URI(url).user
-end
-
-def endpoint_from_url(url)
-  uri      = URI(url)
-  uri.user = nil
-  
-  uri.to_s
-end
-
-def auth_app_key_according_service(service)
-  case service['backend_version']
-  when '1'
-    'user_key'
-  when '2'
-    'app_id'
-  when 'oauth'
-    'oauth'
-  end
-end
-
-case (command = ARGV.shift)
-when 'csv'
-  destination  = fetch_option options, :destination
-  file_path    = fetch_option options, :file
-  endpoint     = endpoint_from_url destination
-  provider_key = provider_key_from_url destination
-
-  client   = ThreeScale::API.new(endpoint: endpoint, provider_key: provider_key)
-  data     = CSV.read file_path
-  headings = data.shift
-  services = {}
-  stats    = { services: 0, metrics: 0, methods: 0 , mapping_rules: 0 }
-
-  # prepare services data
-  data.each do |row|
-    service_name = row[headings.find_index('service_name')]
-    item         = {}
-
-    services[service_name] ||= {}
-    services[service_name][:items] ||= []
-
-    (headings - ['service_name']).each do |heading|
-      item[heading] = row[headings.find_index(heading)]
-    end
-
-    services[service_name][:items].push item
-  end
-
-  services.keys.each do |service_name|
-    # create service
-    service = client.create_service name: service_name
-
-    if service['errors'].nil?
-      stats[:services] += 1
-      puts "Service #{service_name} has been created."
-    else
-      abort "Service has not been saved. Errors: #{service['errors']}"
-    end
-
-    # find hits metric (default)
-    hits_metric = client.list_metrics(service['id']).find do |metric| 
-      metric['system_name'] == 'hits'
-    end
-
-    services[service_name][:items].each do |item|
-
-      metric, method = {}
-      
-      case item['type']
-      # create a metric
-      when 'metric'
-        metric = client.create_metric(service['id'], { 
-          system_name:   item['endpoint_system_name'],
-          friendly_name: item['endpoint_name'],
-          unit:          'unit'
-        })
-
-        if metric['errors'].nil?
-          stats[:metrics] += 1
-          puts "Metric #{item['endpoint_name']} has been created."
-        else
-          puts "Metric has not been saved. Errors: #{metric['errors']}"
-        end
-      # create a method
-      when 'method'
-        method = client.create_method(service['id'], hits_metric['id'], { 
-          system_name:   item['endpoint_system_name'],
-          friendly_name: item['endpoint_name'],
-          unit:          'unit'
-        })
-
-        if method['errors'].nil?
-          stats[:methods] += 1
-          puts "Method #{item['endpoint_name']} has been created."
-        else
-          puts "Method has not been saved. Errors: #{method['errors']}"
-        end
-      end
-
-      # create a mapping rule
-      if (metric_id = metric['id'] || method['id'])
-        mapping_rule = client.create_mapping_rule(service['id'], {
-          metric_id:          metric_id,
-          pattern:            item['endpoint_path'],
-          http_method:        item['endpoint_http_method'],
-          metric_system_name: item['endpoint_system_name'],
-          auth_app_key:       auth_app_key_according_service(service),
-          delta:              1
-        })
-
-        if mapping_rule['errors'].nil?
-          stats[:mapping_rules] += 1
-          puts "Mapping rule #{item['endpoint_system_name']} has been created."
-        else
-          puts "Mapping rule has not been saved. Errors: #{mapping_rule['errors']}"
-        end
-      end
-    end
-  end
-
-  puts "#{services.keys.count} services in CSV file"
-  puts "#{stats[:services]} services have been created"
-  puts "#{stats[:metrics]} metrics have been created"
-  puts "#{stats[:methods]} methods have beeen created"
-  puts "#{stats[:mapping_rules]} mapping rules have been created"
-
-when 'help'
-  print_help.call
-when nil
-  print_help.call('missing subcommand')
-else
-  print_help.call("unknown command #{command}")
-end