3scale_toolbox 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2210eb206ba4503c7a5e144ee02a579e128699e3
-  data.tar.gz: 36bb0f56aefa3366fb804c3c93699a778e982543
+  metadata.gz: 6edc160258055594806f1c1acd494201e8f9ae67
+  data.tar.gz: 3dfe9b992cd0310113edd5eff26499a061a76400
 SHA512:
-  metadata.gz: 1891b41f0278ca43b71fbaa27b05a993babf785917e0fb4dadc5f188db31d6122897dd855e819af0f2ea4951376ef0048d5dde8d7d16ff76c9e71d774ef81d78
-  data.tar.gz: db6158bc763ac25acc70bc12ecac8667d8af0d7572345b3a66244e330a99d39253d3f6b0bf2ec417edfc2a26b1b0bf91a47e4bc811611b0072ac4c270ca862e7
+  metadata.gz: 7c731d310c1ff612f8f522a6c60f61ed37f64b8519ac86121f8a0b0ab776f6b441a2f564f9ac21c1eb783de6903837c533d52d2b37d3e3a03662f5d80eb592d8
+  data.tar.gz: 66c9e710b6764bf1b87a15391b151223c5b23f29532b24b723c583ef241e168308e437bd2d0cf6e785f1fb73e0f3150f6079927b454c3e58cc62664032523cdf

data/README.md

@@ -23,6 +23,14 @@ Will create a new service, copy existing methods, metrics, application plans and
 3scale copy service NUMBER --source=https://provider_key@foo-admin.3scale.net --destination=https://provider_key@foo2-admin.3scale.net
 ```
 
+### Import from CSV
+
+Will create a new services, metrics, methods and mapping rules.
+
+```shell
+3scale import csv --destination=https://provider_key@user-admin.3scale.net --file=examples/import_example.csv
+```
+
 ## 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.

data/exe/3scale-copy

@@ -9,14 +9,18 @@ options = {}
 parser = OptionParser.new do |parser|
   parser.banner = '3scale copy <command> [options]'
 
-  parser.on('-source', '--source SOURCE', "Source") do |domain|
+  parser.on('-s', '--source SOURCE', "Source") do |domain|
     options[:source] = domain
   end
 
-  parser.on('-destination', '--destination DESTINATION', "Destination") do |domain|
+  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
@@ -52,10 +56,19 @@ def endpoint_from_url(url)
   url.sub /\w*@/, ''
 end
 
+def copy_service_params(original, system_name)
+  {
+    name:        original['name'],
+    system_name: system_name,
+    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'
 
@@ -71,10 +84,7 @@ case (command = ARGV.shift)
     )
     
     service = source_client.show_service(service_id)
-    copy    = client.create_service(
-      name: service['name'],
-      end_user_registration_required: service['end_user_registration_required']
-    )
+    copy    = client.create_service(copy_service_params(service, system_name))
 
     raise "Service has not been saved. Errors: #{copy['errors']}" unless copy['errors'].nil?
 

data/exe/3scale-import

@@ -0,0 +1,178 @@
+#!/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 ? metric['id'] : (method ? method['id'] : nil))
+        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

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ executables:
 - 3scale
 - 3scale-copy
 - 3scale-help
+- 3scale-import
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,6 +67,7 @@ files:
 - exe/3scale
 - exe/3scale-copy
 - exe/3scale-help
+- exe/3scale-import
 - lib/3scale_toolbox.rb
 - lib/3scale_toolbox/cli.rb
 - lib/3scale_toolbox/version.rb
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: 3scale CLI Toolbox.