nexmo_markdown_renderer 0.0.1

data/lib/nexmo_markdown_renderer/models/use_case.rb

@@ -0,0 +1,81 @@
+module Nexmo
+  module Markdown
+    class UseCase
+      include ActiveModel::Model
+      attr_accessor :title, :description, :external_link, :products, :document_path, :languages, :root
+    
+      def body
+        File.read(document_path)
+      end
+    
+      def path
+        return external_link if external_link
+        path = document_path.relative_path_from(Nexmo::Markdown::UseCase.origin).sub("#{::I18n.locale}/", '')
+        "/use-cases/#{path}".gsub('.md', '')
+      end
+    
+      def subtitle
+        normalized_products = products.map do |product|
+          normalise_product_title(product)
+        end
+    
+        normalized_products.sort.to_sentence
+      end
+    
+      def normalise_product_title(product)
+        return 'SMS' if product == 'messaging/sms'
+        return 'Voice' if product == 'voice/voice-api'
+        return 'Number Insight' if product == 'number-insight'
+        return 'Messages' if product == 'messages'
+        return 'Dispatch' if product == 'dispatch'
+        return 'Client SDK' if product == 'client-sdk'
+        return 'Subaccounts' if product == 'account/subaccounts'
+        product.camelcase
+      end
+    
+      def self.by_product(product, use_cases = [])
+        use_cases = all if use_cases.empty?
+        use_cases.select do |use_case|
+          use_case.products.include? product
+        end
+      end
+    
+      def self.by_language(language, use_cases = [])
+        language = language.downcase
+        use_cases = all if use_cases.empty?
+    
+        use_cases.select do |use_case|
+          use_case.languages.map(&:downcase).include? language
+        end
+      end
+    
+      def self.origin
+        Pathname.new("#{ENV['DOCS_BASE_PATH']}/_use_cases")
+      end
+    
+      def self.all
+        files.map do |document_path|
+          document_path = Pathname.new(document_path)
+          document = File.read(document_path)
+          frontmatter = YAML.safe_load(document)
+    
+          Nexmo::Markdown::UseCase.new({
+            title: frontmatter['title'],
+            description: frontmatter['description'],
+            external_link: frontmatter['external_link'],
+            products: frontmatter['products'].split(',').map(&:strip),
+            languages: frontmatter['languages'] || [],
+            document_path: document_path,
+            root: origin.to_s,
+          })
+        end
+      end
+    
+      private
+    
+      private_class_method def self.files
+        Dir.glob("#{origin}/**/*.md")
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/android.rb

@@ -0,0 +1,25 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Android < Base
+        def self.dependencies(_deps)
+          {
+            'text' => 'See <a href="https://developer.nexmo.com/use-cases/client-sdk-android-add-sdk-to-your-app">How to Add the Nexmo Client SDK to your Android App</a>',
+          }
+        end
+    
+        def self.run_command(_command, _filename, _file_path)
+          nil
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(_filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_code')
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/base.rb

@@ -0,0 +1,12 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Base
+        def self.inherited(base)
+          base.extend ActionView::Helpers::TranslationHelper
+          base.instance_variable_set :@virtual_path, "services.#{base.name.underscore.tr('/', '.')}"
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/curl.rb

@@ -0,0 +1,29 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Curl < Base
+        def self.dependencies(deps)
+          dependencies = deps.map(&:upcase)
+          raise t('.only_permitted_dependency') unless dependencies.include?('JWT')
+          {
+            'text' => t('.text'),
+            'code' => 'export JWT=$(nexmo jwt:generate $PATH_TO_PRIVATE_KEY application_id=$NEXMO_APPLICATION_ID)',
+          }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end
+    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/dotnet.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Dotnet < Base
+        def self.dependencies(deps)
+          { 'code' => "Install-Package #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(_command, _filename, _file_path)
+          nil
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/java.rb

@@ -0,0 +1,32 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Java < Base
+        def self.dependencies(deps)
+          {
+            'text' => t('services.code_snippet_renderer.add_instructions_to_file', file: 'build.gradle'),
+            'code' => deps.map { |d| "compile '#{d.gsub('@latest', '5.2.1')}'" }.join('<br />'),
+            'type' => 'groovy',
+          }
+        end
+    
+        def self.run_command(_command, filename, file_path)
+          package = file_path.gsub('.repos/nexmo/nexmo-java-code-snippets/src/main/java/', '').tr('/', '.').gsub(filename, '')
+          file = filename.gsub('.java', '')
+          main = "#{package}#{filename.gsub('.java', '')}"
+          chomped_package = package.chomp('.')
+    
+          ::I18n.t('.run_command', chomped_package: chomped_package, package: package, main: main, file: file)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('.create_instructions', file: filename.gsub('.java', ''))
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('.add_instructions', file: filename.gsub('.java', ''))
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/javascript.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Javascript < Base
+        def self.dependencies(deps)
+          { 'code' => "npm install #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/kotlin.rb

@@ -0,0 +1,25 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Kotlin < Base
+        def self.dependencies(_deps)
+          {
+            'text' => 'See <a href="https://developer.nexmo.com/use-cases/client-sdk-android-add-sdk-to-your-app">How to Add the Nexmo Client SDK to your Android App</a>',
+          }
+        end
+    
+        def self.run_command(_command, _filename, _file_path)
+          nil
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(_filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_code')
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/objective_c.rb

@@ -0,0 +1,25 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class ObjectiveC < Base
+        def self.dependencies(_deps)
+          {
+            'text' => 'See <a href="/client-sdk/setup/add-sdk-to-your-app/ios">How to Add the Nexmo Client SDK to your iOS App</a>',
+          }
+        end
+    
+        def self.run_command(_command, _filename, _file_path)
+          nil
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(_filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_code')
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/php.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Php < Base
+        def self.dependencies(deps)
+          { 'code' => "composer require #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/python.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Python < Base
+        def self.dependencies(deps)
+          { 'code' => "pip install #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/ruby.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Ruby < Base
+        def self.dependencies(deps)
+          { 'code' => "gem install #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/swift.rb

@@ -0,0 +1,25 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Swift < Base
+        def self.dependencies(_deps)
+          {
+            'text' => 'See <a href="/client-sdk/setup/add-sdk-to-your-app/ios">How to Add the Nexmo Client SDK to your iOS App</a>',
+          }
+        end
+    
+        def self.run_command(_command, _filename, _file_path)
+          nil
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(_filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_code')
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -0,0 +1,119 @@
+module Nexmo
+  module Markdown
+    class DocFinder
+      class MissingDoc < StandardError; end
+    
+      EXCLUSIONS = ['.', '..', ::I18n.default_locale.to_s].freeze
+    
+      class << self
+        mattr_accessor :paths
+        mattr_accessor :dictionary
+      end
+    
+      # rubocop:disable Metrics/ParameterLists
+      def self.find(root:, document:, language: nil, product: nil, code_language: nil, format: 'md', strip_root_and_language: false)
+        if strip_root_and_language
+          document = strip_root_and_language(root: root, language: "(#{language}|#{::I18n.default_locale})", document: document)
+        end
+        begin
+          if code_language.present?
+            linkable_code_language(
+              root: root,
+              language: language,
+              product: product,
+              document: document,
+              code_language: code_language,
+              format: format
+            )
+          else
+            non_linkable(
+              root: root,
+              language: language,
+              product: product,
+              document: document,
+              format: format
+            )
+          end
+        rescue KeyError => e
+          raise MissingDoc, e.message
+        end
+      end
+    
+      def self.linkable_code_language(root:, language:, document:, product: nil, code_language: nil, format: nil)
+        key = [
+          build_key(root: root, product: product, document: "#{document}/#{code_language}", format: format),
+          build_key(root: root, product: product, document: document, format: format),
+        ].select { |k| dictionary.key?(k) }.first
+    
+        available_language = dictionary.fetch(key).fetch(language, ::I18n.default_locale.to_s)
+        build_doc_path(root, key, available_language)
+      end
+    
+      def self.non_linkable(root:, language:, document:, product: nil, format: nil)
+        key = build_key(root: root, product: product, document: document, format: format)
+        if root.starts_with?('app/views')
+          dictionary.fetch(key) && key
+        else
+          available_language = dictionary.fetch(key).fetch(language.to_s, ::I18n.default_locale.to_s)
+          build_doc_path(root, key, available_language)
+        end
+      end
+      # rubocop:enable Metrics/ParameterLists
+    
+      def self.build_key(root:, document:, product: nil, format: nil)
+        path = if Pathname.new(document).extname.blank?
+                 "#{root}/#{product}/#{document}.#{format}"
+               else
+                 "#{root}/#{product}/#{document}"
+               end
+        path.gsub(%r{\/\/\/|\/\/}, '/')
+      end
+    
+      def self.build_doc_path(root, doc, language)
+        doc.gsub(root, "#{root}/#{language}")
+      end
+    
+      def self.configure
+        self.paths = []
+        self.dictionary = Hash.new { |hash, key| hash[key] = {} }
+    
+        yield(self)
+    
+        load_english
+        load_languages
+      end
+    
+      def self.load_english
+        paths.each do |path|
+          if path.starts_with?('app/views')
+            Dir["#{path}/**/*.*"].each do |file|
+              dictionary[file][::I18n.default_locale.to_s] = ::I18n.default_locale.to_s
+            end
+          else
+            path_with_locale = "#{path}/#{::I18n.default_locale}"
+            Dir["#{path_with_locale}/**/{*.*,.config.yml}"].each do |file|
+              key = "#{path}/#{file.gsub("#{path_with_locale}/", '')}"
+              dictionary[key][::I18n.default_locale.to_s] = ::I18n.default_locale.to_s
+            end
+          end
+        end
+      end
+    
+      def self.load_languages
+        paths.each do |path|
+          Dir.foreach(path).reject { |d| EXCLUSIONS.include? d }.each do |language|
+            Dir.glob("#{path}/#{language}/**/{*.*,.config.yml}").each do |file|
+              doc_name = strip_root_and_language(root: path, language: language, document: file)
+              key = "#{path}/#{doc_name}"
+              dictionary[key][language] = language
+            end
+          end
+        end
+      end
+    
+      def self.strip_root_and_language(root:, language:, document:)
+        document.sub(%r{#{root}\/}, '').sub(%r{#{language}\/}, '')
+      end
+    end    
+  end
+end