genio 1.0.0

data/lib/genio/logging.rb

@@ -0,0 +1,30 @@
+#
+#   Copyright 2013 PayPal Inc.
+# 
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+# 
+#       http://www.apache.org/licenses/LICENSE-2.0
+# 
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+require 'logger'
+
+module Genio
+  class << self
+    attr_accessor :logger
+  end
+  self.logger = Logger.new(STDERR)
+
+  module Logging
+    def logger
+      Genio.logger
+    end
+  end
+end

data/lib/genio/tasks.rb

@@ -0,0 +1,246 @@
+#
+#   Copyright 2013 PayPal Inc.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+require "genio"
+require "thor"
+require "json"
+require "uri"
+require "genio/parser"
+require "pp"
+
+module Genio
+  class Tasks < Thor
+    include Thor::Actions
+    include Template
+
+    class_option :force,  :type => :boolean, :default => false,   :desc => "Overwrite files that already exist"
+    class_option :skip,   :type => :boolean, :default => false,   :desc => "Skip files that already exist"
+
+    # Schema path
+    class_option :json_schema,  :type => :string, :desc => "JSON Schema path"
+    class_option :wsdl,         :type => :string, :desc => "WSDL path"
+    class_option :wadl,         :type => :string, :desc => "WADL path"
+    class_option :schema,       :type => :string, :desc => "Any schema path"
+
+    class_option :output_path,  :type => :string, :default => "output/stubs/"
+    class_option :namespace,    :type => :string,                     :desc => "Dot separated package name"
+    class_option :gen_deprecated_methods, :type => :boolean, :default => false, :desc => "Generate deprecated version of methods using AccessToken parameter"
+
+
+    desc "java", "Generate rest java stubs"
+    method_option :mandate_oauth,  :type => :boolean, :default => true,
+      :desc => "Force APIContext object to include oauth token"
+    def java
+      if schema.is_a? Parser::Format::Wsdl
+        java_with_wsdl
+      else
+        java_with_json_schema
+      end
+    end
+
+    desc "php", "Generate rest php stubs"
+    def php
+      if schema.is_a? Parser::Format::Wsdl
+        php_with_wsdl
+      else
+        php_with_json_schema
+      end
+    end
+
+    desc "dotnet", "Generate rest dotnet stubs"
+    method_option :mandate_oauth,  :type => :boolean, :default => true,
+      :desc => "Force APIContext object to include oauth token"
+    def dotnet
+      if schema.is_a? Parser::Format::Wsdl
+        dotnet_with_wsdl
+      else
+        dotnet_with_json_schema
+      end
+    end
+
+    desc "iodocs", "Generate iodocs"
+    method_option :output_file, :type => :string, :default => "iodocs.json"
+    def iodocs
+      file = File.join(options[:output_path], options[:output_file])
+      create_file(file, JSON.pretty_generate(schema.to_iodocs))
+    end
+
+    private
+
+    def java_with_json_schema
+      folder = options[:output_path]
+      schema.data_types.each do|name, data_type|
+        package = options[:namespace] || convert_ns_to_package(data_type.package || schema.endpoint);
+        render("templates/sdk.rest_java.erb",
+            :data_type => data_type,
+            :classname => name,
+            :schema => schema,
+            :package => package,
+            :helper => Helper::Java,
+            :gen_deprecated_methods => options[:gen_deprecated_methods],
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.java"))
+      end
+      render("templates/sdk.rest_version_java.erb",
+          :create_file => File.join(folder, "com/paypal/sdk/info/SDKVersionImpl.java"))
+    end
+
+    def java_with_wsdl
+      folder = options[:output_path]
+
+      # emit datatypes
+      schema.data_types.each do|name, data_type|
+        package = options[:namespace] || convert_ns_to_package(data_type.package)
+        render("templates/sdk.wsdl_java.erb",
+            :package => package,
+            :classname => name,
+            :schema => schema,
+            :data_type => data_type,
+            :helper => Helper::Java,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.java"))
+      end
+
+      # emit enumtypes
+      schema.enum_types.each do|name, definition|
+        package = options[:namespace] || convert_ns_to_package(definition.package)
+        render("templates/sdk.wsdlenum_java.erb",
+            :package => package,
+            :classname => name,
+            :definition => definition,
+            :helper => Helper::Java,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.java"))
+      end
+
+      # emit service
+      schema.services.each do|name, service|
+        package = options[:namespace] || convert_ns_to_package(service.package)
+        render("templates/sdk.wsdlservice_java.erb",
+            :package => package,
+            :classname => name,
+            :schema => schema,
+            :service => service,
+            :helper => Helper::Java,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.java"))
+      end
+    end
+
+    def php_with_json_schema
+      folder = options[:output_path]
+      schema.data_types.each do|name, data_type|
+        package = get_slashed_package_name(capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || data_type.package || schema.endpoint))))
+        render("templates/sdk.rest_php.erb",
+            :data_type => data_type,
+            :classname => name,
+            :schema => schema,
+            :package => package,
+            :helper => Helper::PHP,
+            :gen_deprecated_methods => options[:gen_deprecated_methods],
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{name}.php"))
+      end
+    end
+
+    def php_with_wsdl
+      folder = options[:output_path]
+      schema.data_types.each do|name, data_type|
+        package = get_slashed_package_name(capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || data_type.package || schema.endpoint))))
+        render("templates/sdk.wsdl_php.erb",
+            :data_type => data_type,
+            :classname => name,
+            :schema => schema,
+            :package => package,
+            :helper => Helper::PHP,
+            :gen_deprecated_methods => options[:gen_deprecated_methods],
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{name}.php"))
+    end
+
+    # emit service
+    schema.services.each do|name, service|
+        package = get_slashed_package_name(capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || service.package || schema.endpoint))))
+        render("templates/sdk.wsdlservice_php.erb",
+            :package => package,
+            :classname => name,
+            :schema => schema,
+            :service => service,
+            :helper => Helper::PHP,
+            :gen_deprecated_methods => options[:gen_deprecated_methods],
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{name}.php"))
+      end
+    end
+
+    def dotnet_with_json_schema
+      folder = options[:output_path]
+      schema.data_types.each do|name, data_type|
+        package = capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || data_type.package || schema.endpoint)))
+        render("templates/sdk.rest_dotnet.erb",
+          :data_type => data_type,
+          :classname => name,
+          :schema => schema,
+          :package => package,
+          :helper => Helper::DotNet,
+          :gen_deprecated_methods => options[:gen_deprecated_methods],
+          :create_file => File.join(folder, "#{get_package_folder(package, true)}/#{validate_file_name(name)}.cs"))
+      end
+      render("templates/sdk.rest_version_dotnet.erb",
+          :create_file => File.join(folder, "PayPal/Sdk/Info/SDKVersionImpl.cs"))
+    end
+
+    def dotnet_with_wsdl
+      folder = options[:output_path]
+
+      # emit datatypes
+      schema.data_types.each do|name, data_type|
+        package = capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || data_type.package)))
+        render("templates/sdk.wsdl_dotnet.erb",
+            :package => package,
+            :classname => name,
+            :schema => schema,
+            :data_type => data_type,
+            :helper => Helper::DotNet,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.cs"))
+      end
+
+      # emit enumtypes
+      schema.enum_types.each do|name, definition|
+        package = capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || definition.package)))
+        render("templates/sdk.wsdlenum_dotnet.erb",
+            :package => package,
+            :classname => name,
+            :definition => definition,
+            :helper => Helper::DotNet,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.cs"))
+      end
+
+      # emit service
+      schema.services.each do|name, service|
+        package = capitalize_package(remove_tld_in_package(convert_ns_to_package(options[:namespace] || service.package)))
+        render("templates/sdk.wsdlservice_dotnet.erb",
+            :package => package,
+            :classname => name,
+            :schema => schema,
+            :service => service,
+            :helper => Helper::DotNet,
+            :create_file => File.join(folder, "#{get_package_folder(package)}/#{validate_file_name(name)}.cs"))
+      end
+    end
+
+    # load the schema by choosing an appropriate parser
+    def schema
+      @schema ||= get_parser(options)
+    end
+
+    include Util::NamespaceHelper
+    include Util::SchemaHelper
+  end
+end

data/lib/genio/template.rb

@@ -0,0 +1,65 @@
+#
+#   Copyright 2013 PayPal Inc.
+# 
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+# 
+#       http://www.apache.org/licenses/LICENSE-2.0
+# 
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+require 'tilt'
+require "thor"
+
+module Genio
+  module Template
+    include Thor::Shell
+    include Thor::Actions
+
+    def render_values
+      @render_values ||= [{}]
+    end
+
+    def render(template, values = {})
+      values = { :create_file => nil }.merge(values)
+      values = render_values.last.merge(values)
+      values[:scope] ||= generate_scope(values)
+      render_values.push(values)
+      content = parse_erb(template, values)
+      render_values.pop
+      create_file(values[:create_file], content) if values[:create_file]
+      content
+    end
+
+    def generate_scope(values)
+      Class.new do
+        include values[:helper] if values[:helper]
+
+        def initialize(klass)
+          @klass = klass
+        end
+
+        def method_missing(name, *args)
+          @klass.send(name, *args)
+        end
+      end.new(self)
+    end
+
+    def parse_erb(template, values)
+      filename = File.absolute_path(template, template_path)
+      template = Tilt::ErubisTemplate.new(Dir["#{filename}*"].first || template)
+      template.render(values[:scope] || self, values)
+    end
+
+    def template_path
+      @template_path ||= File.expand_path("../../../", __FILE__)
+    end
+
+  end
+end

data/lib/genio/util/namespace_helper.rb

@@ -0,0 +1,93 @@
+#
+#   Copyright 2013 PayPal Inc.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+#
+module Genio
+  module Util
+    module NamespaceHelper
+
+      # Checks the format of the namespace as uri or urn,
+      # and converts the namespace to package name ('.' seperated)
+      # eg: http://github.paypal.com/payments/sale is changed to
+      # com.paypal.github.payments.sale
+      # eg: urn:ebay:apis:eBLBaseComponents is changed to
+      # urn.ebay.apis.eBLBaseComponents
+      # any numbers occuring as a part of path in the uri
+      # based namespaces is removed
+      def convert_ns_to_package(ns)
+        if is_urn_ns(ns)
+          packagename = ns.gsub(/:/, "\.")
+        else
+          hostname = URI.parse(ns)
+          packagename = hostname.host.sub(/^www./, "").split(".").reverse.join(".")
+          packagename << hostname.path.to_s.gsub(/[\d-]+/, "").sub(/\/+$/,'').gsub(/-/, '_').gsub(/\/+/, ".")
+        end
+        packagename
+      end
+
+      # Strips a package name off any
+      # Top Level Domains (TLD)s; com, co, org, gov, de, us, in
+      # eg: com.paypal.github.payments.sale is converted to
+      # paypal.github.payments.sale
+      def remove_tld_in_package(packagename)
+        packagename.sub(/^(com|co|org|gov|de|us|in)\./, "")
+      end
+
+      # Lowercases parts of a package name
+      # eg: Paypal.Github.Payments.Sale is converted to
+      # paypal.github.payments.sale
+      def lowercase_package(packagename)
+        packagename.gsub(/([^\.]+[\.]?)/){ |match| $1.camelcase(:lower) }
+      end
+
+      # Capitalizes parts of a package name
+      # eg: paypal.github.payments.sale is converted to
+      # Paypal.Github.Payments.Sale
+      def capitalize_package(packagename)
+        packagename.gsub(/([^\.]+[\.]?)/){ |match| $1.camelcase }
+      end
+
+      # Returns a folder path corresponding to the
+      # packagename; setting capitalize_folder true returns
+      # folder names that are captialized
+      def get_package_folder(packagename, capitalize_folder = false)
+        if (capitalize_folder)
+          capitalize_package(packagename).gsub(/\.|\\/, '/')
+        else
+          packagename.gsub(/\.|\\/, '/')
+        end
+      end
+
+      # Returns a namespace path with '\' corresponding to the
+      # packagename; setting capitalizefolder true returns
+      #  names that are captialized
+      def get_slashed_package_name(packagename, capitalizefolder = false)
+        if (capitalizefolder)
+          capitalize_package(packagename).gsub(/\./, '\\')
+        else
+          packagename.gsub(/\./, '\\')
+        end
+      end
+
+      # Checks if the uri starts with protocol
+      # schemes and returns true, else treats
+      # the namespace as a Uniform Resource Name
+      def is_urn_ns(ns)
+        !ns.start_with?('http:','https:')
+      end
+
+    end
+  end
+end

data/lib/genio/util/schema_helper.rb

@@ -0,0 +1,65 @@
+require 'thor/error'
+
+module Genio
+  module Util
+    module SchemaHelper
+
+      # Decide on a parser from the passed in URI and
+      # return the parser after loading the definition
+      # from the URI
+      def get_parser(options)
+        if options[:wsdl]
+          load_wsdl(options[:wsdl])
+        elsif options[:wadl]
+          load_wadl(options[:wadl])
+        elsif options[:json_schema]
+          load_json_schema(options[:json_schema])
+        elsif options[:schema]
+          get_parser_with_uri(options[:schema])
+        else
+          raise Thor::RequiredArgumentMissingError, "No value provided for required options '--json-schema' or '--wsdl' or '--wadl'"
+        end
+      end
+
+      def get_parser_with_uri(uri)
+        if (uri.end_with?('wadl'))
+          load_wadl(uri)
+        elsif (uri.end_with?('wsdl'))
+          load_wsdl(uri)
+        else
+          load_json_schema(uri)
+        end
+      end
+
+      def load_wsdl(path)
+        schema = Parser::Format::Wsdl.new
+        load_schema_uri(schema, path)
+        schema
+      end
+
+      def load_wadl(path)
+        schema = Parser::Format::Wadl.new
+        load_schema_uri(schema, path)
+        schema
+      end
+
+      def load_json_schema(path)
+        schema = Parser::Format::JsonSchema.new
+        load_schema_uri(schema, path)
+        schema.fix_unknown_service
+        schema
+      end
+
+      def load_schema_uri(parser, uri)
+        uri.split(/,/).each do |path|
+          parser.load(path)
+        end
+      end
+
+      # Replaces '-' with '_' and CamelCase(s)
+      def validate_file_name(name)
+        name.gsub(/-/, "_").camelcase
+      end
+    end
+  end
+end