3scale_toolbox 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c06fef14e4b85f8c23bfbde952198345f502744e
-  data.tar.gz: efd42927ca217afa27625810d1fecab9c23c5316
+SHA256:
+  metadata.gz: 1faca82c3c88cb4312fa76704e70d656a400f53c3aecb03c507e8a1aeb374284
+  data.tar.gz: 32c28726d94b60b8238720b1ffe055b06b4ecb1aab3945fd069b899d19f12595
 SHA512:
-  metadata.gz: 3926f07e4057c625aaff424c16a8721eaa639205abfe5f1d104c78cc9b6da537751289744faab53607e9c4635b2f6b8c3903d007afdc7e7c5aa550c11cf0b5ae
-  data.tar.gz: 6010129bbd8a4a8ce8026ad98dcfaf0749133514be63baccd2c1f9da7b427ef6e74edfebb90cda81e5090f40afedcfbd46ffba6a9907865fb6020b7b0833a18f
+  metadata.gz: 720b320e9e20edecdb93256c2a804ffaff13593f180960e2e10027d5c915c94094a7c2bbf2aca9c9a3b78fc7e9c993bcfc3151d4ac61eab8bf0113a63ed0d5d5
+  data.tar.gz: c27a4f1aea1076ad163437cdf0b0082763a6f49fa10bcd2045fe63047ea08dc3ba0258833f8fcd8015a8de4604909c9ba7cf9b477b55511999a4c3544dcab5a2

data/exe/3scale-copy

@@ -60,6 +60,7 @@ 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

data/exe/3scale-update

@@ -0,0 +1,270 @@
+#!/usr/bin/env ruby
+
+require '3scale_toolbox/cli'
+require 'optparse'
+require '3scale/api'
+require 'uri'
+
+options = {}
+
+parser = OptionParser.new do |parser|
+  parser.banner = '3scale update <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('-f', '--force', 'Overwrites the mapping rules by deleting all rules from target service first') do
+    options[:force] = true
+  end
+
+  # TODO: parametrize what parts of service need to be copied 
+  parser.on('-r', '--rules-only', 'Updates only the mapping rules') do
+    options[:rules_only] = true
+  end
+
+  parser.on('-h', '--help', 'Prints this help') do
+    puts parser
+    puts
+    puts 'Available Commands:', ['service <source_service_id> <destination_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 fetch_option(options, key)
+  options.fetch(key) { raise OptionParser::MissingArgument, key }
+end
+
+class ServiceUpdater
+
+  attr_reader :source_client, :target_client, :source_service_id, :target_service_id
+
+  def initialize (source, source_service_id, destination, target_service_id)
+    @source_client = ThreeScale::API.new(
+      endpoint:     endpoint_from_url(source), 
+      provider_key: provider_key_from_url(source)
+    )
+    @target_client = ThreeScale::API.new(
+      endpoint:     endpoint_from_url(destination), 
+      provider_key: provider_key_from_url(destination)
+    )
+    @source_service_id = source_service_id
+    @target_service_id = target_service_id
+  end
+
+  def compare_hashes(first, second, keys)
+    keys.map{ |key| first.fetch(key) } == keys.map{ |key| second.fetch(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 target_service_params(source)
+    # NOTE: backend_version and deployment_option are not yet returned by show_service method
+    params = %w(name backend_version deployment_option end_user_registration_required)
+    source.select { |k,v| params.include?(k) && v }
+  end
+
+  def source_metrics
+    @source_metrics ||= source_client.list_metrics(source_service_id)
+  end
+
+  def metrics_mapping
+    @metrics_mapping ||= target_client.list_metrics(target_service_id).map do |target|
+      metric = source_metrics.find{|metric| metric.fetch('system_name') == target.fetch('system_name') }
+      metric ||= {}
+
+      [metric['id'], target['id']]
+    end.to_h
+  end
+
+  def copy_service_settings
+    source_service = source_client.show_service(source_service_id)
+    puts "updating service settings for service id #{target_service_id}..."
+    target_update_response = target_client.update_service(target_service_id, target_service_params(source_service))
+    raise "Service has not been saved. Errors: #{target_update_response['errors']}" unless target_update_response['errors'].nil?
+  end
+
+  def copy_proxy_settings
+    puts "updating proxy configuration for service id #{target_service_id}..."
+    proxy = source_client.show_proxy(source_service_id)
+    target_client.update_proxy(target_service_id, proxy)
+    puts "updated proxy of #{target_service_id} to match the source #{source_service_id}"
+  end
+
+  def copy_metrics_and_methods
+    target_metrics = target_client.list_metrics(target_service_id)
+
+    source_hits = source_metrics.find{ |metric| metric['system_name'] == 'hits' } or raise 'missing hits metric'
+    target_hits = target_metrics.find{ |metric| metric['system_name'] == 'hits' } or raise 'missing hits metric'
+
+    source_methods = source_client.list_methods(source_service_id, source_hits['id'])
+    target_methods = target_client.list_methods(target_service_id, target_hits['id'])
+
+    puts "source service hits metric #{source_hits['id']} has #{source_methods.size} methods"
+    puts "target service hits metric #{target_hits['id']} has #{target_methods.size} methods"
+
+    missing_methods = source_methods.reject { |source_method|  target_methods.find{|target_method| compare_hashes(source_method, target_method, ['system_name']) } }
+
+    puts "creating #{missing_methods.size} missing methods on target service..."
+    missing_methods.each do |method|
+      target = { friendly_name: method['friendly_name'], system_name: method['system_name'] }
+      target_client.create_method(target_service_id, target_hits['id'], target)
+    end
+
+    target_metrics = target_client.list_metrics(target_service_id)
+
+    puts "source service has #{source_metrics.size} metrics"
+    puts "target service has #{target_metrics.size} metrics"
+
+    missing_metrics = source_metrics.reject { |source_metric| target_metrics.find{|target_metric| compare_hashes(source_metric, target_metric, ['system_name']) } }
+
+    missing_metrics.map do |metric|
+      metric.delete('links')
+      target_client.create_metric(target_service_id, metric)
+    end
+
+    puts "created #{missing_metrics.size} metrics on the target service"
+  end
+
+  def copy_application_plans
+    source_plans = source_client.list_service_application_plans(source_service_id)
+    target_plans = target_client.list_service_application_plans(target_service_id)
+
+    puts "source service has #{source_plans.size} application plans"
+    puts "target service has #{target_plans.size} application plans"
+
+    missing_application_plans = source_plans.reject { |source_plan| target_plans.find{|target_plan| source_plan.fetch('system_name') == target_plan.fetch('system_name') } }
+
+    puts "creating #{missing_application_plans.size} missing application plans..."
+
+    missing_application_plans.each do |plan|
+      plan.delete('links')
+      plan.delete('default') # TODO: handle default plans
+
+      if plan.delete('custom') # TODO: what to do with custom plans?
+        puts "skipping custom plan #{plan}"
+      else
+        target_client.create_application_plan(target_service_id, plan)
+      end
+    end
+
+    puts "updating limits for application plans..."
+
+    application_plan_mapping = target_client.list_service_application_plans(target_service_id).map do |plan_target|
+      plan = source_plans.find{|plan| plan.fetch('system_name') == plan_target.fetch('system_name') }
+      plan ||= {}
+      [plan['id'], plan_target['id']]
+    end.to_h.reject { |key, value| !key }
+
+    application_plan_mapping.each do |source_id, target_id|
+      source_limits = source_client.list_application_plan_limits(source_id)
+      target_limits = target_client.list_application_plan_limits(target_id)
+
+      missing_limits = source_limits.reject { |limit| target_limits.find{|limit_target| limit.fetch('period') == limit_target.fetch('period') } }
+
+      puts "target application plan #{target_id} is missing #{missing_limits.size} from the source plan #{source_id}"
+
+      missing_limits.each do |limit|
+        limit.delete('links')
+        target_client.create_application_plan_limit(target_id, metrics_mapping.fetch(limit.fetch('metric_id')), limit)
+      end
+      
+    end
+  end
+
+  def copy_mapping_rules force_mapping_rules
+    source_mapping_rules = source_client.list_mapping_rules(source_service_id)
+    target_mapping_rules = target_client.list_mapping_rules(target_service_id)
+
+    puts "the source service has #{source_mapping_rules.size} mapping rules"
+    puts "the target has #{target_mapping_rules.size} mapping rules"
+
+    if force_mapping_rules
+      puts "force mode was chosen, deleting existing mapping rules on target service..."
+      target_mapping_rules.each do |rule|
+        target_client.delete_mapping_rule(target_service_id, rule['id'])
+      end
+      missing_mapping_rules = source_mapping_rules
+    else
+      unique_target_mapping_rules = target_mapping_rules.dup
+
+      missing_mapping_rules = source_mapping_rules.reject do |mapping_rule|
+        matching_metric = unique_target_mapping_rules.find do |target|
+          compare_hashes(mapping_rule, target, %w(pattern http_method delta)) &&
+              metrics_mapping.fetch(mapping_rule.fetch('metric_id')) == target.fetch('metric_id')
+        end
+
+        unique_target_mapping_rules.delete(matching_metric)
+      end
+    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'))
+      target_client.create_mapping_rule(target_service_id, mapping_rule)
+    end
+    puts "created #{missing_mapping_rules.size} mapping rules"
+  end
+
+  def update_service force_mapping_rules=false
+    copy_service_settings
+    copy_proxy_settings
+    copy_metrics_and_methods
+    copy_application_plans
+    copy_mapping_rules force_mapping_rules
+  end
+end
+
+case (command = ARGV.shift)
+  when 'service'
+    source      = fetch_option options, :source
+    destination = fetch_option options, :destination
+
+    rules_only = options[:rules_only] == true
+    force_update = options[:force] == true
+
+    source_service_id = ARGV.shift or raise OptionParser::MissingArgument, 'source_service_id'
+    target_service_id = ARGV.shift or raise OptionParser::MissingArgument, 'destination_service_id'
+  
+    updater = ServiceUpdater.new(source, source_service_id, destination, target_service_id)
+
+    if rules_only
+      updater.copy_mapping_rules force_update
+    else
+      updater.update_service force_update
+    end
+
+  when 'help'
+    print_help.call
+  when nil
+    print_help.call("missing subcommand")
+    exit 1
+  else
+    print_help.call("unknown command #{command}")
+    exit 1
+end

data/lib/3scale_toolbox/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ executables:
 - 3scale-copy
 - 3scale-help
 - 3scale-import
+- 3scale-update
 extensions: []
 extra_rdoc_files: []
 files:
@@ -68,6 +69,7 @@ files:
 - exe/3scale-copy
 - exe/3scale-help
 - exe/3scale-import
+- exe/3scale-update
 - lib/3scale_toolbox.rb
 - lib/3scale_toolbox/cli.rb
 - lib/3scale_toolbox/version.rb
@@ -91,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: 3scale CLI Toolbox.