swagger-shell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e597c90a4b76d100bc2b694fb7d389346bb71a4a
+  data.tar.gz: c41111166cd641a11160ea6d36e9125ee4955af7
+SHA512:
+  metadata.gz: 532e20ab70c63eae78e26ecc26936ccd481b50f1cae09275e25f99123ade51bf507108c2947e0148e44d89e283328cc86903d3e933daaedcd908f95d5dd61ddf
+  data.tar.gz: e82eb55767a67935952862495cdd6fcb42595124a18f12c250b2de7ad7553eec60325d482636eadd3dad6498cf11c31a663624b56e5683b9eb04cfea7c28ff6e

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore bundler gems.
+vendor/bundle
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.10
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in swagger-shell.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    swagger-shell (0.0.1)
+      faraday (~> 0.10)
+      parallel (~> 1.12)
+      pry (~> 0.11)
+      rb-readline (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.2)
+    multipart-post (2.0.0)
+    parallel (1.12.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  swagger-shell!

data/README.md

@@ -0,0 +1,35 @@
+# Swagger::Shell
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swagger/shell`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger-shell'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-shell
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger-shell.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger/shell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/swagger-shell

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger/shell"
+
+Swagger::Shell.start(self, ARGV[0])

data/config/env.yml

@@ -0,0 +1,10 @@
+default: &default
+  api_url: https://petstore.swagger.io
+  docs_url: v2/swagger.json
+
+  request_headers:
+    Content-Type: 'application/json; charset=utf-8'
+    Content-Encoding: gzip
+
+develop:
+  <<: *default

data/config/swagger-shell.yml

@@ -0,0 +1,7 @@
+api:
+  ignore_top_url: /
+pry:
+  prompt_name: swagger-shell
+  home: ~/.swagger-shell/
+  history_file: history
+  users_file: users

data/lib/swagger/shell/api_struct.rb

@@ -0,0 +1,171 @@
+module Swagger
+  module Shell
+    module ApiGet
+      def get(message = {})
+        _get(api_url, message)
+      end
+    end
+
+    module ApiPost
+      def post(message = {})
+        _post(api_url, message)
+      end
+    end
+
+    module ApiPut
+      def put(message = {})
+        _put(api_url, message)
+      end
+    end
+
+    module ApiDelete
+      def delete(message = {})
+        _delete(api_url, message)
+      end
+    end
+
+    class ApiStruct
+      attr_reader :parent, :children
+
+      def initialize(key, parent = nil)
+        @key = key
+        @parent = parent
+        @children = []
+      end
+
+      def root?
+        @parent.nil?
+      end
+
+      def api_key
+        @key
+      end
+
+      def method_key
+        root? ? "api" : @key
+      end
+
+      def add_api(path_keys, method, api_info: nil)
+        find_or_create_api_struct(path_keys).tap do |api_struct|
+          api_struct.add_api_module(method) if api_struct
+        end
+      end
+
+      def api_list
+        @children.each_with_object({}) do |key, hash|
+          hash.merge!(instance_variable_get("@#{key}").api_list)
+        end.tap do |hash|
+          api_methods.each do |api_method|
+            hash[api_method] = ""
+          end
+        end
+      end
+
+      def api_url
+        # TODO: Is there simply + no problem?　If possible, pass from outside.
+        Swagger::Shell.config_api.ignore_top_url + api_ancestors.map(&:api_key).join("/")
+      end
+
+      def api_methods
+        %i[get post put delete].map do |method|
+          (api_ancestors.map(&:method_key) << method).join(".") if singleton_class.include? self.class.module_class(method)
+        end.compact
+      end
+
+      def api_ancestors
+        loop.inject([self]) do |parents|
+          break parents if parents.last.parent.nil?
+          parents << parents.last.parent
+          parents
+        end.reverse
+      end
+
+      def add_api_module(method)
+        extend self.class.module_class(method)
+      end
+
+      def child(path_key)
+        # not implement url with id (i.g.: hoge/111/age)
+        # TODO: (i.g.: api.hoge(111).age.post )
+        return nil if /\A\{\w+\}\Z/.match(path_key)
+
+        unless respond_to? path_key
+          instance_variable_set("@#{path_key}", ApiStruct.new(path_key,self))
+          instance_eval <<-RUBY
+            def self.#{path_key}
+              @#{path_key}
+            end
+          RUBY
+          @children << path_key.to_sym
+        end
+
+        instance_variable_get("@#{path_key}")
+      end
+
+      def user
+        Swagger::Shell.user
+      end
+
+      def self.module_class(method)
+        camelize_name = method.to_s.dup.tap {|s| s[0] = s[0].upcase }
+        Swagger::Shell.const_get("Api#{camelize_name}")
+      end
+
+      private
+
+      def hook_request_body(body)
+        body
+      end
+
+      def hook_request_headers
+        Swagger::Shell.config_env.request_headers.to_h
+      end
+
+      def hook_response_body(body)
+        # TODO: need to implement expect for json
+        JSON.parse body, symbolize_names: true
+      end
+
+      def find_or_create_api_struct(path_keys)
+        path_keys.inject(self) do |api_struct, path_key|
+          break nil if api_struct.nil?
+
+          api_struct.child(path_key)
+        end
+      end
+
+      def _get(url, message = {})
+        _request(:get, url, message)
+      end
+
+      def _post(url, message = {})
+        _request(:post, url, message)
+      end
+
+      def _put(url, message = {})
+        _request(:put, url, message)
+      end
+
+      def _delete(url, message = {})
+        _request(:delete, url, message)
+      end
+
+      def _request(method, url, params = {})
+        res = begin
+          client = Faraday.new(:url => Swagger::Shell.config_env.api_url)
+          client.public_send(method) do |req|
+            req.url url
+            hook_request_headers.each do |k, v|
+              req.headers[k] = v.to_s
+            end
+            req.body = hook_request_body(params).to_json
+          end
+        rescue => e
+          raise e
+        end
+
+        hook_response_body(res.body)
+      end
+    end
+  end
+end

data/lib/swagger/shell/doc_loader.rb

@@ -0,0 +1,35 @@
+module Swagger
+  module Shell
+    class DocLoader
+      def load(url)
+        api_docs = JSON.parse(Faraday.new(url: url).get.body)
+        swagger_version = api_docs["swaggerVersion"] || api_docs["swagger"]
+
+        ApiStruct.new(api_docs["basePath"]).tap do |root_api|
+          # TODO: refactor
+          if swagger_version == "1.2"
+            api_docs["apis"].each do |api|
+              api_body = JSON.parse Faraday.new(url: url + api["path"].gsub("{format}", :json.to_s)).get.body
+
+              api_body["apis"].each do |api2|
+                # 冗長なパスを排除
+                path = api2["path"].gsub(/^#{Swagger::Shell.config_api.ignore_top_url}/, "")
+                path_keys = path.split("/").reject {|s| s == "" }.tap {|p| p.last.gsub!(".json", "") }
+
+                root_api.add_api(path_keys, api2["operations"].first["method"])
+              end
+            end
+          elsif swagger_version == "2.0"
+            api_docs["paths"].each do |path, methods|
+              methods.each do |method, api_info|
+                # TODO: ignore path
+                path_keys = path.split("/").reject {|s| s == "" } # TODO: format // .tap {|p| p.last.gsub!(".json", "") }
+                root_api.add_api(path_keys, method, api_info: api_info)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/shell/interface.rb

@@ -0,0 +1,73 @@
+require "pry"
+require "json"
+require "faraday"
+require "fileutils"
+require "yaml"
+
+module Swagger
+  module Shell
+    module Interface
+      def start_shell
+        Pry.config.prompt_name = Swagger::Shell.config_pry.prompt_name || "swagger-shell"
+
+        FileUtils.mkdir_p(Swagger::Shell.config_pry.home)
+        Pry.config.history.file = Swagger::Shell.config_pry.history_path || "~/.swagger-shell/history"
+
+        bootstrap
+
+        Pry.history.load
+        Pry.start
+      end
+
+      def api
+        Swagger::Shell.api
+      end
+
+      def user
+        Swagger::Shell.user
+      end
+
+      def bootstrap
+        user.load_sample
+        begin
+          if user.info.nil?
+            user.create
+            puts "create user_id: #{user.id}"
+          else
+            user.login
+            puts "load user_id: #{user.id}"
+          end
+        rescue
+          puts "failed load user_id: #{user.id}"
+        end
+      end
+
+      # output API list
+      #
+      # option # TODO: implement
+      # p: output parameter name
+      # s: output summary
+      #
+      # no option output summary.
+      #
+      # e.g.:
+      # swagger-shell(main)> apis :p
+      def apis(option = "")
+        option = option.to_s
+
+        with_parameter = option.include?("p")
+        with_summary = option.include?("s") || option.size.zero?
+
+        api_list = api.api_list
+        max_key_size = api_list.keys.map(&:size).max
+        api_list.sort.each do |api, operation|
+          output = "#{api}#{" " * (max_key_size - api.size)}"
+          output += " # #{(operation["parameters"] || []).map {|p| p["name"][8..-2] }.join(" ")}" if with_parameter
+          output += " # #{operation["summary"]}" if with_summary
+          puts output
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/swagger/shell/user.rb

@@ -0,0 +1,63 @@
+module Swagger
+  module Shell
+    class User
+      attr_reader :id, :info
+
+      def load_sample
+        id = list.sample
+        return if id.nil?
+        load_by(id)
+      end
+
+      def load_by(id)
+        @id = id
+        @info = YAML.load_file("#{users_path}/#{Swagger::Shell.env}.#{@id}.yml")
+      end
+
+      def list
+        Dir.glob("#{users_path}/#{Swagger::Shell.env}.*.yml").map {|f| File.basename(f, ".yml").gsub(/^#{Swagger::Shell.env}\./, "") }
+      end
+
+      def clean!
+        Dir.glob("#{users_path}/#{Swagger::Shell.env}.*.yml") {|f| File.delete f }
+        @info = nil
+      end
+
+      def save(id, info)
+        @id = id
+        @info = info
+
+        save_to_yml(@id, @info)
+      end
+
+      def create
+        # need to override
+      end
+
+      def login
+        # need to override
+      end
+
+      # patch
+      def debug
+        command = "open #{Swagger::Shell.config_env.debug_url}/#{id}"
+        puts command
+        `#{command}`
+        nil
+      end
+
+      private
+
+      def save_to_yml(filename, data)
+        FileUtils.mkdir_p(users_path)
+        open("#{users_path}/#{Swagger::Shell.env}.#{filename}.yml","w") do |f|
+          YAML.dump(data, f)
+        end
+      end
+
+      def users_path
+        Swagger::Shell.config_pry.users_path
+      end
+    end
+  end
+end

data/lib/swagger/shell/version.rb

@@ -0,0 +1,5 @@
+module Swagger
+  module Shell
+    VERSION = "0.0.1"
+  end
+end

data/lib/swagger/shell.rb

@@ -0,0 +1,70 @@
+require "swagger/shell/api_struct"
+require "swagger/shell/doc_loader"
+require "swagger/shell/interface"
+require "swagger/shell/user"
+require "swagger/shell/version"
+require "json"
+
+module Swagger
+  module Shell
+    class << self
+      def env=(env)
+        @env = env
+      end
+
+      def env
+        @env
+      end
+
+      def config_env
+        @config_env ||= hash_to_struct(YAML.load_file("config/env.yml")[env.to_s]).tap do |config|  # TODO: pass outside
+          raise "not exist env: #{env}" if config.nil?
+          config.docs_url = File.join(config.api_url, config.docs_url) unless config.docs_url.start_with? "http"
+        end
+      end
+
+      def config_api
+        @config_api ||= hash_to_struct(YAML.load_file("config/swagger-shell.yml")["api"]).tap do |_config|  # TODO: pass outside
+          # noting to do
+        end
+      end
+
+      def config_pry
+        @config_local ||= hash_to_struct(YAML.load_file("config/swagger-shell.yml")["pry"]).tap do |config| # TODO: pass outside
+          config.home = config.home.gsub(/^~/, Dir.home) if config.home.start_with?("~/")
+          config.history_path = File.join(config.home, config.history_file)
+          config.users_path = File.join(config.home, config.users_file)
+        end
+      end
+
+      def user
+        @user ||= User.new
+      end
+
+      def api
+        @aip ||= DocLoader.new.load(config_env.docs_url)
+      end
+
+      def registered_interfaces
+        @registered_interfaces ||= []
+      end
+
+      def register_interface(interface_module)
+        registered_interfaces << interface_module
+      end
+
+      def start(main, env = nil)
+        self.env = env || :default
+        main.extend Swagger::Shell::Interface
+        registered_interfaces.each do |interface|
+          main.extend interface
+        end
+        main.start_shell
+      end
+
+      def hash_to_struct(hash)
+        JSON.parse hash.to_json, object_class: OpenStruct
+      end
+    end
+  end
+end

data/swagger-shell.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swagger/shell/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger-shell"
+  spec.version       = Swagger::Shell::VERSION
+  spec.authors       = ["Junya Tokumori"]
+  spec.email         = ["rimokuto@gmail.com"]
+
+  spec.summary       = "swagger-shell"
+  spec.description   = "shell cli for swagger"
+  spec.homepage      = "https://github.com/rimokuto/swagger-shell"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.10" # TODO: net/http
+  spec.add_dependency "parallel", "~> 1.12"
+  spec.add_dependency "pry", "~> 0.11"
+  spec.add_dependency "rb-readline", "~> 0.5" # TODO: if possible to delete
+
+  # spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: swagger-shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Junya Tokumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: shell cli for swagger
+email:
+- rimokuto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/swagger-shell
+- config/env.yml
+- config/swagger-shell.yml
+- lib/swagger/shell.rb
+- lib/swagger/shell/api_struct.rb
+- lib/swagger/shell/doc_loader.rb
+- lib/swagger/shell/interface.rb
+- lib/swagger/shell/user.rb
+- lib/swagger/shell/version.rb
+- swagger-shell.gemspec
+homepage: https://github.com/rimokuto/swagger-shell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.5
+signing_key: 
+specification_version: 4
+summary: swagger-shell
+test_files: []