openai_101 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ebf546c03971c1d5a9da6dd30e35911e1220205244ea8b73ed24ec92b2b21e5
+  data.tar.gz: aaf3db3e9919146dbbb786105696845035cd4eacfc7b7c75186449df3d1f9f7b
+SHA512:
+  metadata.gz: 1544585db91c6e0b45944a2e236d5e10310560b9c4950756c07f7804659fa911e7aa980c4417c8d025e243dd0ed6e29bc66dc406974ffeb81fd41db9353e4bc2
+  data.tar.gz: 26e54c68e02682ec7eff41ea45e49eec9323f6c89a8de45245f8be9262ade51acbdbfc39facd1ccb16d85c4cccb1bdaef4fdfac9608c7a7038ab0e84062ad147

data/.builders/_.rb

@@ -0,0 +1 @@
+# require_relative './path/here'

data/.builders/boot.rb

@@ -0,0 +1,39 @@
+# Boot Sequence
+
+include KLog::Logging
+
+CONFIG_KEY = :openai_101
+
+log.kv 'working folder', Dir.pwd
+
+KConfig.configure do |config|
+  config.handlebars.defaults.add_all_defaults
+end
+
+def k_builder
+  @k_builder ||= KBuilder::BaseBuilder.init(KConfig.configuration(CONFIG_KEY))
+end
+
+KConfig.configure(CONFIG_KEY) do |config|
+  builder_folder    = Dir.pwd
+  base_folder       = File.expand_path('../', builder_folder)
+  global_template   = File.expand_path('~/dev/kgems/k_templates/templates')
+
+  config.template_folders.add(:global_template    , global_template)
+  config.template_folders.add(:template           , File.expand_path('.templates', Dir.pwd))
+
+  config.target_folders.add(:app                  , base_folder)
+  config.target_folders.add(:builder              , builder_folder)
+end
+
+KConfig.configuration(CONFIG_KEY).debug
+
+area = KManager.add_area(CONFIG_KEY)
+resource_manager = area.resource_manager
+resource_manager
+  .fileset
+  .glob('*.rb', exclude: ['boot.rb'])
+  .glob('generators/**/*.rb')
+resource_manager.add_resources
+
+KManager.boot

data/.builders/generators/01-bootstrap.rb

@@ -0,0 +1,134 @@
+KManager.action :bootstrap do
+  action do
+    application_name = :openai_101
+
+    # Ruby Gem Bootstrap
+    director = KDirector::Dsls::RubyGemDsl
+      .init(k_builder,
+        on_exist:                   :skip,                      # %i[skip write compare]
+        on_action:                  :queue                      # %i[queue execute]
+      )
+      .data(
+        ruby_version:               '3.2',
+        application:                application_name,
+        application_description:    'OpenAI 101 Series on using OpenAI ChatGPT, DALL·E, and other OpenAI endpoints',
+        application_lib_path:       application_name.to_s, # need a specialized handlebars helper to turn this into a path, e.g ps-common => ps/common
+        application_lib_namespace:  'Openai101',
+        namespaces:                 ['Openai101'],
+        author:                     'David Cruwys',
+        author_email:               'david@ideasmen.com.au',
+        initial_semver:             '0.0.1',
+        main_story:                 'As a software developer, I want to understand OpenAI endpoints and capabilities, so that I can use ChatGPT effectively',
+        copyright_date:             '2024',
+        website:                    'http://appydave.com/gems/openai_101'
+      )
+      .github(
+        active: false,
+        repo_name: application_name
+      ) do
+        create_repository
+        # delete_repository
+        # list_repositories
+        open_repository
+        # run_command('git init')
+      end
+      .blueprint(
+        active: false,
+        name: :bin_hook,
+        description: 'initialize repository',
+        on_exist: :write) do
+
+        cd(:app)
+
+        run_template_script('bin/runonce/git-setup.sh', dom: dom)
+
+        add('.githooks/commit-msg').run_command('chmod +x .githooks/commit-msg')
+        add('.githooks/pre-commit').run_command('chmod +x .githooks/pre-commit')
+
+        add('.gitignore')
+
+        run_command('git config core.hooksPath .githooks') # enable sharable githooks (developer needs to turn this on before editing rep)
+
+        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
+        run_command("gh repo edit -d \"#{dom[:application_description]}\"")
+      end
+      .package_json(
+        active: false,
+        name: :package_json,
+        description: 'Set up the package.json file for semantic versioning'
+      ) do
+        self
+          .add('package.json', dom: dom)
+          .play_actions
+
+        self
+          .add_script('release', 'semantic-release')
+          .sort
+          .development
+          .npm_add_group('semver-ruby')
+
+        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
+      end
+      .blueprint(
+        active: false,
+        name: :opinionated,
+        description: 'opinionated GEM files',
+        on_exist: :write) do
+
+        cd(:app)
+
+        add('bin/setup')
+        add('bin/console')
+
+        applet_path = typed_dom.namespaces.map { |ns| ns.downcase }.join('/')
+        
+        add("lib/#{applet_path}.rb"               , template_file: 'lib/applet_name.rb'         , dom: dom)
+        add("lib/#{applet_path}/version.rb"       , template_file: 'lib/applet_name/version.rb' , dom: dom)
+    
+        add('spec/spec_helper.rb')
+        add("spec/#{applet_path}_spec.rb"         , template_file: 'spec/applet_name_spec.rb', dom: dom)
+
+        add("#{typed_dom.application}.gemspec"    , template_file: 'applet_name.gemspec', dom: dom)
+        add('Gemfile', dom: dom)
+        add('Guardfile', dom: dom)
+        add('Rakefile', dom: dom)
+        add('.rspec', dom: dom)
+        add('.rubocop.yml', dom: dom)
+        add('README.md', dom: dom)
+        add('CODE_OF_CONDUCT.md', dom: dom)
+        add('LICENSE.txt', dom: dom)
+
+        run_command("rubocop -a")
+      
+        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
+      end
+      .blueprint(
+        active: true,
+        name: :ci_cd,
+        description: 'github actions (CI/CD)',
+        on_exist: :write) do
+
+        cd(:app)
+
+        # run_command("gh secret set SLACK_WEBHOOK --body \"$SLACK_REPO_WEBHOOK\"")
+        run_command("gh secret set GEM_HOST_API_KEY --body \"$GEM_HOST_API_KEY\"")
+
+        add('.github/workflows/main.yml')
+        add('.releaserc.json')
+
+        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
+      end
+
+    director.play_actions
+    # director.builder.logit
+  end
+end
+
+KManager.opts.app_name                    = 'openai_101'
+KManager.opts.sleep                       = 2
+KManager.opts.reboot_on_kill              = 0
+KManager.opts.reboot_sleep                = 4
+KManager.opts.exception_style             = :short
+KManager.opts.show.time_taken             = true
+KManager.opts.show.finished               = true
+KManager.opts.show.finished_message       = 'FINISHED :)'

data/.releaserc.json

@@ -0,0 +1,40 @@
+{
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@klueless-js/semantic-release-rubygem",
+      {
+        "gemPublish": true
+      }
+    ],
+    [
+      "@semantic-release/changelog",
+      { 
+        "changelogFile": "CHANGELOG.md",
+        "changelogFileTitle": "Openai 101 Changelog"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "lib/openai_101/version.rb",
+          "CHANGELOG.md"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "repositoryUrl": "git@github.com:klueless-io/openai_101.git"
+}

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,104 @@
+inherit_mode:
+  merge:
+    - Exclude # see: https://stackoverflow.com/a/70818366/473923
+    - AllowedNames
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.2
+  DisplayCopNames: true
+  ExtraDetails: true
+  NewCops: enable
+  Exclude:
+    - ".builders/**/*"
+    - "spec/samples/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/spec/**/*"
+    - "*.gemspec"
+  AllowedMethods:
+    - configure
+    - context
+    - define
+    - describe
+    - draw
+    - factory
+    - feature
+    - guard
+    - included
+    - it
+    - let
+    - let!
+    - scenario
+    - setup
+    - shared_context
+    - shared_examples
+    - shared_examples_for
+    - transaction
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Max: 200
+  # Ignores annotate output
+  # AllowedPatterns: ['\A# \*\*'] # this is renamed to AllowedPatterns and I need to come up with a template for this
+  IgnoreCopDirectives: true
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Style/BlockComments:
+  Enabled: false
+  Include:
+    - "**/spec/*"
+
+# My Preferences - Start
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Exclude:
+    - "**/spec/**/*"
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
+Naming/MethodParameterName:
+  AllowedNames:
+    - as
+Style/EmptyMethod:    
+  Exclude:
+    - "**/spec/**/*"
+Metrics/ParameterLists:
+  Exclude:
+    - "**/spec/**/*"
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - "**/spec/**/*"
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "**/spec/**/*"
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Layout/SpaceBeforeComma:
+  Enabled: false
+# My Preferences - End
+
+# RSpec Cops
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/FilePath:
+  Exclude:
+    - "**/spec/**/*"
+
+RSpec/NamedSubject:
+  Exclude:
+    - "**/spec/**/*"

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at david.cruwys@bugcrowd.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openai_101.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rake'
+  gem 'rake-compiler', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :test do
+  gem 'simplecov', require: false
+end

data/Guardfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+guard :bundler, cmd: 'bundle install' do
+  watch('Gemfile')
+  watch('.gemspec')
+end
+
+group :green_pass_then_cop, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec -f doc' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+    watch(%r{^lib//(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch(%r{^lib//commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+    watch(/{.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 David Cruwys
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# Openai 101
+
+> OpenAI 101 Series on using OpenAI ChatGPT, DALL·E, and other OpenAI endpoints
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openai_101'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install openai_101
+```
+
+## Stories
+
+### Main Story
+
+As a software developer, I want to understand OpenAI endpoints and capabilities, so that I can use ChatGPT effectively
+
+See all [stories](./STORIES.md)
+
+
+## Usage
+
+See all [usage examples](./USAGE.md)
+
+
+
+## Development
+
+Checkout the repo
+
+```bash
+git clone https://github.com/klueless-io/openai_101
+```
+
+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.
+
+```bash
+bin/console
+
+Aaa::Bbb::Program.execute()
+# => ""
+```
+
+`openai_101` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
+
+To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+```bash
+rake publish
+rake clean
+```
+
+## Git helpers used by this project
+
+Add the follow helpers to your `alias` file
+
+```bash
+function kcommit()
+{
+  echo 'git add .'
+  git add .
+  echo "git commit -m "$1""
+  git commit -m "$1"
+  echo 'git pull'
+  git pull
+  echo 'git push'
+  git push
+  sleep 3
+  run_id="$(gh run list --limit 1 | grep -Eo "[0-9]{9,11}")"
+  gh run watch $run_id --exit-status && echo "run completed and successful" && git pull && git tag | sort -V | tail -1
+}
+function kchore     () { kcommit "chore: $1" }
+function kdocs      () { kcommit "docs: $1" }
+function kfix       () { kcommit "fix: $1" }
+function kfeat      () { kcommit "feat: $1" }
+function ktest      () { kcommit "test: $1" }
+function krefactor  () { kcommit "refactor: $1" }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/openai_101. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Openai 101 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/openai_101/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# source: https://stephenagrice.medium.com/making-a-command-line-ruby-gem-write-build-and-push-aec24c6c49eb
+
+GEM_NAME = 'openai_101'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'openai_101/version'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+desc 'Compile all the extensions'
+task build: :compile
+
+Rake::ExtensionTask.new('openai_101') do |ext|
+  ext.lib_dir = 'lib/openai_101'
+end
+
+desc 'Publish the gem to RubyGems.org'
+task :publish do
+  version = Openai101::VERSION
+  system 'gem build'
+  system "gem push #{GEM_NAME}-#{version}.gem"
+end
+
+desc 'Remove old *.gem files'
+task :clean do
+  system 'rm *.gem'
+end
+
+task default: %i[clobber compile spec]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'openai_101'
+
+# 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,11 @@
+#!/usr/bin/env bash
+
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openai_101/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openai101
+  VERSION = '0.0.2'
+end