orphic 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada9df94e25136b9bc904ccb6545f0c58c12746769cdee512f5ea00c7833d243
-  data.tar.gz: 878409e5056c6589c44e3bd627504070cb670a9e87990acc98221b98870241cc
+  metadata.gz: '067634208ad0e7347f6b554b58c211e2a06aae99981c6649e341b424e6bf24fd'
+  data.tar.gz: d7c0787c643400acc40adeeb291cdf77dc29d61dd8ccad8ddb66ec875a1204f7
 SHA512:
-  metadata.gz: 701b671bad7165eecaebcfd694348382551eec03f828e3e96c664d4cb53b47a47dd489cc30b74aedec66b1539edfc7ed19452a6ab2d64f2e929404db48fd3b7a
-  data.tar.gz: 38f24720c83ff341765c7620c96163dfa87e5e2770222a545810cb899143c8d023280f3caf4327ece23074d56769f3e9f273aafdab87d4512a09e5875edba23f
+  metadata.gz: d633fddbea6e4d1a4ae8f33999ba3e70f6173e37004b3579227ec5421d2f163d1ef3d2e04dc2fa60e85a6169505632c4f3ac50002fe37eb2d6cb2a57c1c9eb67
+  data.tar.gz: fd02419293607d19aa20bd39ae8e8c759e49571169b7cd1f7efb768b97fa1bc81f71ad4910c8fe1875c2bf5a46bc510e748bcffe54d2160f7d147e4cd6dc5f1e

data/README.md

@@ -1,10 +1,8 @@
-# Orphic
+# Ruby Orphic CLI
 
-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/orphic`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/orphic.svg)](https://badge.fury.io/rb/orphic)
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+## Quick Installation
 
 Add this line to your application's Gemfile:
 
@@ -20,9 +18,162 @@ Or install it yourself as:
 
     $ gem install orphic
 
-## Usage
+## Additional Installation Details
+
+You'll need [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and Rubygems installed for the Ruby Orphic CLI to function and develop your own commands or plugins. This is built using the [Thor toolkit (Insecure Link!)](http://whatisthor.com/) and [Ruby on Rails](https://rubyonrails.org/).
+
+If looking to develop your own front end, check out our [rails fork here](https://github.com/orphic-inc/ruby-orphic-cli/tree/main/orphic-rails). You can [Get Started with Rails](https://guides.rubyonrails.org/getting_started.html) by following the linked guide and for more in-depth tutorials check out [Team Tree House](https://teamtreehouse.com/library/topic:ruby).
+
+## Basic Guide to a Web Development environment for the Orphic CLI
+
+// TODO
+
+### Getting Started
+
+The Orphic CLI runs on both Ruby and NodeJS, and to get started with either we recommend using [Brew](https://brew.sh) on Linux and Unix distros (including macOS), or [Chocolatey](https://chocolatey.org/) for Windows users. The CLI is currently focused on *-nix* developer environments, but v2 will focus on Windows PowerShell shortcuts via Chocolatey. With these package managers you can install [nvm](https://github.com/nvm-sh/nvm) and [rbenv](https://github.com/rbenv/rbenv), software that will create environments for any specified version. We recommend Ruby version 2.7.1 and Node version 12 or 14. [Google is your friend](https://lmgtfy.com/?q=install+ruby+and+rubygems), and this is a [good article for macOS users](https://www.moncefbelyamani.com/the-definitive-guide-to-installing-ruby-gems-on-a-mac/). If those steps are complete, you can install the gem locally with `gem install orphic`.
+
+### Developer Installation
+
+Once the steps above are complete, you'll need the Bundler Ruby gem to locally bundle any changes made with `gem install bundler`. For more on [Bundler](https://bundler.io/) and Gemfiles, check out the [bundler docs here](https://bundler.io/gemfile.html). To build from source, clone the repo, access the directory and run `bundle install`. We strongly recommend using version control before continuing further. You can clone the ruby-orphic-cli repository into your own and once your changes are complete, they can be submitted for review via a Pull Request. If unfamiliar with git, Orphic recommends [Git SCM](https://git-scm.com/). 
+
+## macOS
+
+macOS includes a version of ruby and for that reason Orphic recommends using shims via rbenv to maintain a separate development environment. Our codebase is on Ruby 2.7.2, so your mileage may vary, but feel free to submit an Issue for any unexpected outcomes with replicable steps to anticipate the same conclusion. 
+
+# Example neo commands:
+
+## orphic help
+
+This will help you get started, there are currently these commands and subcommands available:
+
+```
+hello
+ -Uppercase -- Uppercase flag
+node
+  node hello
+  node help
+   -tags -- tags option
+   Command -- (req.) argument
+  node deploy
+   -Site -- Site flag
+   -baseDistrict -- argument
+map -- view map commands
+  map 
+    -createDistrict
+  map 
+    -viewDistrict
+  map
+    -Spools
+media
+    -TYPE -- Type flag
+Spools
+  Paji
+    posPaji
+    update_Paji
+  Cursor
+    posCursor
+    GeekCursor
+    mongoDb
+     mongo_URL - (req.) argument
+  Geek
+    Data
+  Flash
+    require Geek
+    puts "hi from flash"
+```
+
+# Example dev commands:
+
+## `bundle exec exe/orphic help`
+
+## Publishing the Ruby gem
+
+[Start with this doc](https://guides.rubygems.org/publishing/) and [your own test ruby gem](https://guides.rubygems.org/make-your-own-gem/#documenting-your-code), you can copy an [early branch if you'd like](https://rubygems.org/gems/orphic/versions/0.1.0).
+
+This will help you get started:
+`nano lib/orphic/version.rb`
+`rm *i*`
+`bundler install`
+`gem build`
+`gem publish *i*`
+
+## Git
+
+Create a new branch with git to something like `git branch`.
+
+## Example HTTP headers
+```
+Request headers
+X-Forwarded-For: {IP address}
+Cache-control: no-cache
+Authorization: {auth token}
+User-Agent: {your custom user agent}
+Response headers
+Access-Control-Allow-Origin: *
+X-Frame-Options: deny
+```
+
+## Roadmap
+
+### Shell Geek
+
+### Jekyll Geek
+
+### Brew Geek
+
+### Chocolatey Geek
+
+### Node Geek
+
+### BigCommerce Geek
+
+### Google Cloud Geek
+
+# spools
+
+A spool can be most likened to a volume or book in that threads make up pages, where a spool can ascertain specific locations where Geeks were infantized, using the Paji and Cursor Geeks respectively. Paji specifies for uncommon keywords or commands you may not yet be familiar with, but has been identified as a Cursor Geek by Flash. Flash assists with real-time rendering and ephemeral changes. This creates a perpetual system via [Relational and Non-Relational databases](https://medium.com/@zhenwu93/relational-vs-non-relational-databases-8336870da8bc), as seen in our [example mongoDb doc](https://github.com/orphic-inc/ruby-orphic-cli/blob/main/orphic/lib/orphic/cli/sprites/cursor.rb).
+
+# Threads
+
+For each Geek, several inputs could be throughput as-is included with the example Geek. The reason "disc" or the equivalent of a hard-reset/disco is highly recommended, but not required falls on a few reasons:
+
+The map command provides access to infinite tiers of districts, within reason unless things break which is cause to believe unreasonable in scope.
+
+While a mechanism for invoking scope and difference of equation from the original scope of a project (or "District"), custom Districts can invoke their own commands via this CLI which can create interesting effects with APIs.
+
+# Districts
+
+To create a District, it is required to have an accessible (via SSL and redirected to SSL) API ([Example](https://tudio.us/api/auth)) which returns a [valid](https://jwt.io/introduction) [JWT]([More Info]), and Orphic Enterprises provides base districts for [these factors](https://12factor.net/):
+
+# Sprites
+
+Sprites serve as directional input, whether intentional or unintentional, serving a focal point for where all attention has become interest with a beginning state of (0,0).
+
+// TODO
+
+## Geek: Declarative
+
+### I - Awake - Infant: Codebase
+#### II - Growth - Rookie: Dependencies
+#### III - Discovery - Champion: Config
+
+## Flash: Maximum Portability
+
+### IV - Trust - Angel: Backing Services
+#### V - Truth - Fallen Angel: Build, Release, Run
+#### VI - Magic - Version: Processes
+
+## Paji: Continuous Deployment
+
+### VII - Poetry - Distinct: Port Binding
+#### VIII - Drive - Professional: Concurrency
+#### IX - Will - Mega: Disposability
+
+## Cursor: Scale Up
 
-TODO: Write usage instructions here
+### X - Loyal - Penultimate: Dev/Prod Parity
+#### XI - Enthusiasm - Ultimate: Logs
+#### XII - Clarity - Awesome: Maximum Portability
 
 ## Development
 
@@ -32,7 +183,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/orphic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/orphic/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/orphic-inc/ruby-orphic-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/orphic-inc/ruby-orphic-cli/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +192,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Orphic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/orphic/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Orphic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/orphic-inc/ruby-orphic-cli/blob/master/CODE_OF_CONDUCT.md).

data/lib/orphic.rb

@@ -4,8 +4,8 @@ require "orphic/cli"
 module Orphic
 # TODO
   CLI::UI::StdoutRouter.enable
-    CLI::UI::Frame.open('Orphic Developer Experience') do
+    CLI::UI::Frame.open('Orphic Ruby CLI') do
       CLI::UI::Frame.open('Ruby CLI') { puts "The Orphic Ruby CLI utilizes the Thor gem for self-documenting commands and cli-ui gem for UI." }
-      puts "Great minds never think alike."
+      puts "CLI, API, DB, e."
   end
 end

data/lib/orphic/cli.rb

@@ -10,7 +10,7 @@ module Orphic
     desc "hello NAME", "This will greet you"
     long_desc <<-HELLO_WORLD
 
-    `hello NAME` will print out a message to the person of your choosing.
+    `hello NAME` will print out a message to the person of your choosing. Todo: title screen.
 
     HELLO_WORLD
     option :upcase

data/lib/orphic/cli/district.rb

@@ -17,18 +17,18 @@ module Orphic
       long_desc <<-CREATE_DISTRICT
         Create a new district with createDistrict. Base map includes the following options for branching:
 
-        \x5--AWAKE - The entrypoint. Create command line interfaces, web portals, and related tech.
-        \x5--GROW - User Interfaces and Experiences, projects here relate to front-end like React, CSS, and prototypes.
-        \x5--DISCOVER - Your current location. Educate your peers or yourself.
-        \x5--TRUST - Create authorization, cyphers, and cryptography-related projects.
-        \x5--TRUTH - The gateway. Can be used to verify authorizations and is often tied to the Trust District.
-        \x5--MAGIC - Let the magic begin! Here you can create ephemeral changes and middleware.
-        \x5--POETRY - The poet, the lover, and the coder are of imagination all compact... Code as art.
-        \x5--DRIVE - Real-time commands that will effect a concurrent stream or processes.
-        \x5--WILL - Databases and permanence.
-        \x5--LOYAL - The gauntlet. Test your loyalty with user or unit testing.
-        \x5--ENTHUSE - Live events and promotions.
-        \x5--CLARITY - The endgame, from your command-line, through staging and production.
+        \x5--AWAKE - I. Infant - The entrypoint. Create command line interfaces, web portals, and related tech. Factor: Codebase
+        \x5--GROW - II. Child - User Interfaces and Experiences. Projects here relate to front-end like React, CSS, and prototypes. Factor: Dependencies
+        \x5--DISCOVER - III. Adolescent - Your current location. Educate your peers or yourself. Factor: Config
+        \x5--TRUST - IV. Rookie - Create authorization, cyphers, and cryptography-related projects. Factor: Backing Services
+        \x5--TRUTH - V. Amateur - The gateway. Can be used to verify authorizations and should be tied to the Trust District. Factor: Build, Release, Run
+        \x5--MAGIC - VI. Associate - Let the magic begin! Create ephemeral changes and middleware. Factor: Processes
+        \x5--POETRY - VII. Professional - The poet, the lover, and the coder are of imagination all compact... Code as art. Factor: Port Binding
+        \x5--DRIVE - VIII. Master - Real-time commands that effects streams or processes. Factor: Concurrency
+        \x5--WILL - IX. Legend - Databases and permanence. Factor: Disposability
+        \x5--LOYAL - X. Penultimate - The gauntlet. Test your loyalty with user or unit testing. Factor: Dev/Prod Parity
+        \x5--ENTHUSE - XI. Ultimate - Live events and promotions. Factor: Logs
+        \x5--CLARITY - XII. Awesome - The endgame, from your command-line, through staging and production. Factor: Admin Process
       CREATE_DISTRICT
       option :awake
       option :grow

data/lib/orphic/cli/spools.rb

@@ -21,8 +21,9 @@ module Orphic
       subcommand "Cursor", Orphic::OrphicCli::Cursor
       desc "spools Paji", "Access a spool with Paji"
       subcommand "Paji", Orphic::OrphicCli::Paji
-      # desc "spools thread Flash", OrphicCli::Thread::Cursor
-      # subcommand "thread Flash", OrphicCli::Thread::Paji
+      desc "spools Thread Flash", "Threads atomize obtuse objects, Flash follows homeostatic patterns. Paired with Cursor or Paji."
+      subcommand "Thread Cursor", Orphic::OrphicCli::Thread
+      # subcommand "Thread Paji", Orphic::OrphicCli::Thread::Paji
     end
   end
 end

data/lib/orphic/cli/sprites/cursor.rb

@@ -1,4 +1,6 @@
 require 'mongo'
+require 'orphic/cli/sprites/flash'
+require 'orphic/cli/sprites/geek'
 
 module Orphic
   module OrphicCli
@@ -20,10 +22,10 @@ module Orphic
       long_desc <<-GEEK_CURSOR
         Info about Geek's instructions, discs, and audio or video if supplied.
       GEEK_CURSOR
-      option :ins
-      option :disc
-      option :audio
-      option :video
+      option :ins, :required => true
+      option :disc, :type => :boolean
+      option :audio, :type => :hash
+      option :video, :type => :hash
       def GeekCursor ( currentGeek )
         CLI::UI::Frame.open( "Cursor :: Geek : " + currentGeek ) do
           puts "#{currentGeek}"

data/lib/orphic/cli/sprites/flash.rb

@@ -1,6 +1,11 @@
-# todo
 require 'orphic/cli/sprites/geek'
 
-# send discs here, this is where the lifecycle of a composition
-puts {"hi from Flash"}
+# todo
+#if flash
+#    flashState = true
+#end
 
+# send discs here, this is where the lifecycle of a composition
+#if disc
+#    discState = true
+#end

data/lib/orphic/cli/sprites/geek.rb

@@ -1,21 +1,46 @@
 # pseudo-code
-class Data
-  
-  # required datasets
-  def i(ins)
-    # if (Cursor <= i) then
-    puts  "i !<= 0"
-    $ins = "ins"
-    return $ins
+module Orphic
+  module OrphicCli
+    class Thread < Thor
+      desc "Cursor", "This geek's location."
+      long_desc <<-CURSOR
+        The real Cursor.
+
+      CURSOR
+      def Cursor()
+        __FILE__
+        puts "The Real Cursor."
+      end
+      desc "Paji", "Pajination (Paginated journaling)"
+      long_desc <<-PAJI
+        The real Paji.
+
+      PAJI
+      def Paji()
+        __LINE__
+        puts "The Real Paji."
+      end
+      puts "Cursor"
+      puts "Paji"
+        # required datasets
+        def i(ins)
+    
+          # if (Cursor <= i) then
+          puts  "i !<= 0"
+          $ins = "ins"
+          return $ins
+        end
+        # instructions, bootload 'this'
+        def d(disc)
+          $d = "disc"
+          puts $d
+          puts "disc"
+      end
+    # check if additional instructions available, if not disconnect
+    # not required but recommended for when things break
+    $a = "audio"
+    $v = "video"
+
+    end
   end
-  # instructions, bootload 'this'
-  def d(disc)
-    $d = "disc"
-    puts $d
-    puts "disc"
-  end
-  # check if additional instructions available, if not disconnect
-  # not required but recommended for when things break
-  $a = __FILE__
-  $v = __LINE__
-end
+end

data/lib/orphic/cli/sprites/paji.rb

@@ -1,3 +1,6 @@
+require 'orphic/cli/sprites/flash'
+require 'orphic/cli/sprites/geek'
+
 module Orphic
   module OrphicCli
     class Paji < Thor

data/lib/orphic/version.rb

@@ -1,3 +1,3 @@
 module Orphic
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/orphic.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency "thor", "~> 0.20"
   spec.add_dependency "cli-ui", "~> 1.4"
+  spec.add_dependency "dotenv", "~> 2.1"
   spec.add_dependency "stripe", "~> 5.28"
   spec.add_dependency "rails", "~> 6.0.3"
   spec.add_dependency "mongo", "~> 2.14.0.rc1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orphic
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Kyle OBrien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: stripe
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +250,7 @@ metadata:
   bug_tracker_uri: https://github.com/orphic-inc/ruby-orphic-cli/issues
   changlog_uri: https://github.com/orphic-inc/ruby-orphic-cli/blob/main/CHANGELOG.md
   documentation_uri: https://github.com/orphic-inc/ruby-orphic-cli/blob/main/README.md
-  source_code_uri: https://github.com/orphic-inc/ruby-orphic-cli/tree/v0.1.8
+  source_code_uri: https://github.com/orphic-inc/ruby-orphic-cli/tree/v0.1.9
   wiki_uri: https://github.com/orphic-inc/ruby-orphic-cli/wiki
 post_install_message:
 rdoc_options: []