oak-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42742f45f4e185f8a2ca56d893f1f27da0a9b00c321a5260e90d95b74556d31c
-  data.tar.gz: 0b8e7861ea2bf38585fcf42be718941c0f0caeb5a847e62eccf18b3d90f5fc5a
+  metadata.gz: b76688f0f340c45b69ee2ecd0a979d357fe5079d6e0c4af0e233d1dd63c1b499
+  data.tar.gz: 07aade4191b0334d2adde947bacc897cc27fe673593fbed84a06458da03aefef
 SHA512:
-  metadata.gz: 69cd81baf442638b28f14729011a9c6173fdf2acc19de62ffc449690e81ca01b8defa9f029353cd2dfc8cfcab7964c33613cf02c3236889105741630fbd93725
-  data.tar.gz: df97d1fee1917a92d8e7cf2aab598fd9113c60c37ec6f1c2acd4fde63a1e1ce5588112cc751886bc124469f8f4af05195f062bce0cd8ab4b47eb51a0d30af16c
+  metadata.gz: d2b05cb1a62d437db88eab0d4d229e981a3e5c8da10529c16092f84fd188f7a0bdfc277b55e85efaa0050ff6a79f2c2b79433bc360b5048f7c2e45c9058e9739
+  data.tar.gz: 58e207df921218b6deac9215f72736343ca8bda5d37a21fc48e4d1611cf5e3c143d9b911787ab6914cffb5c8f3b9e4d833c154709c02e85aaf483a756623b0b0

data/.gitignore

@@ -20,6 +20,7 @@
 /log/*
 /public/*
 /db/*
+/etc/*
 
 # files
 *.dump
@@ -44,6 +45,7 @@ core.*
 cscope.out
 secrets.yml
 .tags
+NOTES*
 
 # don't ignore
 !.gitignore

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 sergioro
+Copyright (c) 2021 Oak Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,26 @@
-# Oak::Api
-
-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/oak/api`. 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 'oak-api'
+# Oak API tool
+
+This gem looks for your API key in the `OAK_API_KEY` shell variable.
+
+After setting such variable let the magic begin:
+
+```bash
+# list available API endpoints
+$ oak -l
+["/api/docs/?",
+ "/api/blog/ids/?",
+ "/api/endpoints",
+ ...
+
+# get a blog post data
+$ oak g blog/3
+{"post_title"=>"Third Post",
+ "post_markdown"=>"Testing 3",
+ "post_slug"=>"third-post",
+ "post_draft"=>false,
+ "post_categories"=>"cook",
+ "post_created_at"=>"2021-03-13",
+ "post_prev"=>"second-post",
+ "post_next"=>"starting-the-oak-blog"}
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install oak-api
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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]/oak-api.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/oak

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require "oak_api"
 
-Oak.greetings
+Oak.go(ARGV.dup)

data/lib/oak/easter_egg.rb

@@ -2,13 +2,13 @@ require 'zlib'
 
 module Oak
   OakString = <<~tree
-    eJyNksFqxCAQhu8+hXhJC9E8QI/tykBbcujCUggYRNjeAj3nXfJEeaf+E+Ou
-    ruzSIWLi/834j1HIm3CtbpTCi0KMWhtRyFAz1rWt1kNOtM0uaM0Fgo3LzxnT
-    YRityEcoIZ0oa3AZ8ijlglXasC9R6ljiPTavMGqci8BT7TTFmNoZUTDqbh/X
-    eElOdgLTqBvyMOGcMbmVYZPRiwFAozaBrLo0guPjCpClJJIyZFoKFqEFWyks
-    EcXjcXejTpMzEW1ZOOnT4eO1/zxUzHAnb+b5unTsK+h/iZxLxbaPEuWQdcTf
-    p3Xpt+dtXb7WJfbfPapQNJffpmsEsL5aHWpjJtgwe/zU280SOl1AsoFm8scC
-    ngQcfPN5oK8W2wICRT8TDOASvf9O5zMI8QdEy6kN
+    eJyNUrFqwzAQ3fULXQ4tbsGSWzxmTCMO2uKhhlBqkBGCdAmGzv74PsVWLFsk
+    9EDI3Hv37t1ZgjZhS1XIGL1SWqxgoAnXlqVS1KWUspgRpYKCN1P6KeFUOFpJ
+    dhMpUiqx1ggy7CBlvZFKB2NijSMVeuBLSjjV1k6Ex9xqjD7O00Nwwu18lthF
+    JzMDV68KdjBhrdaple4CYxYNAvdKezbyOgj2FxQAEzET+QSLEUBg3mRIgJin
+    9dibkZfRyMyXqooevl929a6uz3Q8vO+bjwMyz+dtQXdDZAx3klvU2oZa3oiN
+    /1TJxI5N8/oZte6pUJcMvllLda9uNWz61Jbw4Los2+V2tDd+dPjj22aROlyJ
+    bDyP7NoVeRBw8BVWgmlKtAUJLP4ZYAAv7O13OJ3AEH+N0q0z
   tree
     .delete("\s")
 

data/lib/oak/errors.rb

@@ -1,5 +1,6 @@
-class Oak
+module Oak
   class OakError < StandardError; end
   class SomeWeirdError < OakError; end
+  class UnknownHTTPVerb < OakError; end
 end
 

data/lib/oak/monkey.rb

@@ -0,0 +1,8 @@
+# monkey patches
+
+class Object
+  # use for debugging
+  def info(*args)
+    puts "\e[32m=> #{args}\e[0m"
+  end
+end

data/lib/oak/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oak
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/oak_api.rb

@@ -2,46 +2,127 @@ $LOAD_PATH.unshift __dir__
 
 # stdlib
 require 'optparse'
+require 'net/http'
+require 'json'
 
 # internal
-require 'oak/api'
 require 'oak/version'
+require 'oak/monkey'
 require 'oak/easter_egg'
 
 module Oak
-  def self.run(args)
-    options = Options.parse(args)
+  def self.go(args)
+    Oak::Request.new(args).go
   end
 
-  class Options
-    def self.parse(args)
-      options = {}
+  class Request
+    DEFAULT_HEADERS = {'authorization' => ENV['OAK_API_KEY']}
 
-      OptionParser.new do |opts|
-        opts.program_name = File.basename(bash)
-        opts.banner = "Usage: #{opts.program_name} [options]"
+    class HTTP
+      attr_reader :verb, :uri, :headers, :body
 
-        opts.separator = ""
-        opts.separator = "Options:"
+      VERBS = { g: :get, p: :post, c: :patch, d: :delete }
 
-        opts.on("-oNAME", "--output=NAME", "Specify output file name") do |v|
-          options[:output] = v
-        end
+      def initialize(args, base_url, api_version, headers, debug=nil)
+        @verb = args.shift.to_sym
+        @uri = URI("#{base_url}/api/#{api_version}/#{args.shift}")
+        @body = args.shift
+        @verb = VERBS[@verb] || @verb
+        @headers = headers
+        raise UnknownHTTPVerb unless VERBS.values.include?(@verb)
+      end
 
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          options[:verbose] = v
-        end
+      def set_request
+        @req = Net::HTTP.const_get(verb.to_s.capitalize).new(uri, headers)
+        @req.body = body
+        @req
+      end
+    end
+
+    attr_reader :options, :base_url, :args, :debug, :headers
+
+    def initialize(args)
+      @options = Options.parse(args)
+      @args = args
+      @base_url = development? ? 'http://localhost:3000' : 'https://oak.software'
+      @options[:headers] = @options[:headers].to_h.merge({'authorization' => ENV['OAK_API_KEY_DEVEL']}) if development?
+      @headers = DEFAULT_HEADERS.merge(@options[:headers].to_h)
+      @debug = @options[:debug]
+      info self if @debug
+    end
+
+    def development?
+      @options[:environment] == 'development'
+    end
+
+    def go
+      if @options[:list]
+        args.unshift(?g, "endpoints")
+      end
+
+      req = HTTP.new(args, base_url, options[:api], headers, debug).set_request
+
+      info [req, req.uri, req.uri.host, req.uri.port, req.body] if debug
+      info req.to_hash if debug
+
+      http = Net::HTTP.new(req.uri.host, req.uri.port)
+      http.use_ssl = true unless development?
+      res = http.request(req)
+
+      puts res.body
+    end
+
+    class Options
+      def self.parse(args)
+        options = {}
+
+        OptionParser.new do |opts|
+          opts.program_name = 'oak-api'
+          opts.banner = "Usage: #{opts.program_name} [options] [http_verb] [endpoint] [http_body]"
+
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-d", "--debug", "Enable debug mode") do |v|
+            options[:debug] = v
+          end
+
+          opts.on("-e", "--environment=ENV", "Enable debug mode ") do |v|
+            options[:environment] = v
+          end
+
+          opts.on("-l", "--list", "List API endpoints") do |v=x|
+            options[:list] = v
+          end
+
+          opts.on_tail("-a", "--api=VERSION", "Target a specific API version (defaults to latest)") do |v|
+            options[:api] = v
+          end
+
+          opts.on_tail("-H", "--headers=HEADERS", "HEADERS is a JSON string with HTTP headers") do |v|
+            options[:headers] = JSON.parse(v)
+          end
+
+          opts.on("-o", "--output=NAME", "Specify output file name") do |v|
+            options[:output] = v
+          end
+
+          opts.on("-t", "--tree", "Print a welcome message") do |v|
+            Oak.greetings
+            abort
+          end
 
-        opts.on_tail("-h", "--help", "Print help", "something else") do |v|
-          abort opts.to_s
-        end
+          opts.on_tail("-h", "--help", "Print help", "something else") do |v|
+            abort opts.to_s
+          end
 
-        opts.on_tail("-V", "--version", "Print version") do |v|
-          abort "#{opts.program_name} #{VERSION}"
-        end
-      end.parse!(args)
+          opts.on_tail("-v", "--version", "Print version") do |v|
+            abort "#{opts.program_name} #{VERSION}"
+          end
+        end.parse!(args)
 
-      options
+        options
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oak-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Oak Software
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -178,12 +178,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exe/oak
-- lib/oak/api.rb
 - lib/oak/easter_egg.rb
 - lib/oak/errors.rb
+- lib/oak/monkey.rb
 - lib/oak/version.rb
 - lib/oak_api.rb
 - oak-api.gemspec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "oak/api"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/lib/oak/api.rb

@@ -1,6 +0,0 @@
-module Oak
-  module Api
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end