openai_101 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d33410818e89daeeb9011d5a75ed0063fb91fe86c6d5f7a3ab792fc2017d45c0
-  data.tar.gz: 6ffeba5c3a534647b3fa05835086cf5fdc481c296962795f60880b26415a2626
+  metadata.gz: 736a2e322937831de006aa62307bd82605fc2cb77d9e6558ae6899b637ec5c02
+  data.tar.gz: b6ff2b19719ea9314efc81579c29fe1f157cc26535ed74a0e99b45e9acc81707
 SHA512:
-  metadata.gz: a3403d3d15af8f001c6056c1d120ab3f683854cef5d2cec1275d88a4edfb96a4342bb6cd836d86b9451d571e4324e9b9313d9be56f11c1c582b52204d932fb03
-  data.tar.gz: c624cd17e5603d40c30e13a7753243a3882dd3f1e592e84935eb1b9b46b3edb7be715af15d198f95c6af9241a4d49fa064828f0477625d2b2a51efeae5de179a
+  metadata.gz: 1140a2e1d2076876595ffa2e79d3195248e027b0599a9937ce2d2ca1b717324c5f1b409bfe2dcdb1b66c5cce167989a4d7c8440715886e22ab2e3e9a3dd2cc84
+  data.tar.gz: 6d81917562203fa94a619f3f00eac01ba3c4d9a8ecea46a70e6ac761b8439241bebaedd776ce0dd262ed0f2f642e8499c1d920690549890eb2f03c59440b4175

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,135 @@
+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.0',
+        application:                application_name,
+        application_description:    'OpenAI 101 working through the API 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 Developer, I want to understand openai/chatgpt APIs, so that I can build AI applications effectively',
+        copyright_date:             '2024',
+        website:                    'http://appydave.com/gems/openai_101'
+      )
+      .github(
+        active: false,
+        repo_name: application_name,
+        organization: 'appydave'
+      ) 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

@@ -36,5 +36,5 @@
     ],
     "@semantic-release/github"
   ],
-  "repositoryUrl": "git@github.com:klueless-io/openai_101.git"
+  "repositoryUrl": "git@github.com:appydave/openai_101.git"
 }

data/.rubocop.yml

@@ -7,14 +7,13 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.0
   DisplayCopNames: true
   ExtraDetails: true
   NewCops: enable
   Exclude:
     - ".builders/**/*"
     - "spec/samples/**/*"
-    - "spec/openai_101/tools/**/*"
 
 Metrics/BlockLength:
   Exclude:
@@ -40,22 +39,8 @@ Metrics/BlockLength:
     - shared_examples_for
     - transaction
 
-Metrics/AbcSize:
-  Max: 25
-  Exclude:
-    - "lib/openai_101/tools/edl_to_chapters.rb"
-    - "lib/openai_101/tools/clean_ruby_errors.rb"
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - "lib/openai_101/tools/clean_ruby_errors.rb"
-
 Metrics/MethodLength:
-  Exclude:
-    - "lib/openai_101/tools/edl_to_chapters.rb"
-    - "lib/openai_101/tools/clean_ruby_errors.rb"
-    - "lib/openai_101/tools/sanitize_all_webp_files"
-    - "lib/openai_101/tools/webp_to_png.rb"
+  Max: 25
 
 Layout/LineLength:
   Max: 200
@@ -110,14 +95,12 @@ Layout/SpaceBeforeComma:
 RSpec/NestedGroups:
   Max: 5
 
-RSpec/FilePath:
-  Exclude:
-    - "**/spec/**/*"
+RSpec/SpecFilePathFormat:
+  Enabled: true
+
+RSpec/SpecFilePathSuffix:
+  Enabled: true
 
 RSpec/NamedSubject:
   Exclude:
     - "**/spec/**/*"
-
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/openai_101/config/openai_spec.rb'

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.2
+ruby 3.3.3

data/CHANGELOG.md

@@ -1,19 +1,19 @@
-## [0.0.2](https://github.com/klueless-io/openai_101/compare/v0.0.1...v0.0.2) (2024-02-08)
+# [0.2.0](https://github.com/appydave/openai_101/compare/v0.1.0...v0.2.0) (2024-06-19)
 
 
-### Bug Fixes
+### Features
 
-* namespace issue ([cbcbeb8](https://github.com/klueless-io/openai_101/commit/cbcbeb80c204954a1cfb6db4102e9acaa6844a52))
-* ruby 2.7 & 3.2 ([0af05e1](https://github.com/klueless-io/openai_101/commit/0af05e1e0e99bf08ebc4e7396bd55d10005d25e8))
-* ruby 3.2 only ([d9c463a](https://github.com/klueless-io/openai_101/commit/d9c463a2775efd19d88e4d73402392fbe8c42d01))
-* semantic release 19 ([c123a3f](https://github.com/klueless-io/openai_101/commit/c123a3f9cfa85dfa96769e38ea9f98b84cf94156))
-* semantic release 19 ([e5251b1](https://github.com/klueless-io/openai_101/commit/e5251b1a8ac102533fb9253f8ffb1676c86e385d))
-* semantic release 21 ([62ba587](https://github.com/klueless-io/openai_101/commit/62ba5870dabfe24c150943cdcd62e1a24c53a885))
-* update ruby version ([142cff3](https://github.com/klueless-io/openai_101/commit/142cff346b41aac6e8b6083f970a03c1681c23ad))
-* update ruby version ([f378f52](https://github.com/klueless-io/openai_101/commit/f378f520a8578372834ec57bdf6b2f4b16be813c))
+* moved repo to appydave organization ([dd59698](https://github.com/appydave/openai_101/commit/dd596981dc69723a1c59b53db845f29d616f0540))
+
+# [0.1.0](https://github.com/appydave/openai_101/compare/v0.0.1...v0.1.0) (2024-06-19)
+
+
+### Features
+
+* moved repo to appydave organization ([3b01048](https://github.com/appydave/openai_101/commit/3b01048e2e0f381a6ab5bc0a7cfb4cedd83da88f))
 
 ## [Unreleased]
 
-## [0.1.0] - 2024-02-09
+## [0.1.0] - 2024-06-19
 
 - Initial release

data/README.md

@@ -1,22 +1,6 @@
-DAVID: Check this out, should add it into the openAI course:
-
-https://www.loom.com/share/117eb552f1974f3d8e28463e9f1809e1
-
-Based on:
-
-https://innovate-aiml-data-apj.virtual.awsevents.com/media/10.%20Codenator%3A%20Enhancing%20user%20productivity%20through%20AI-powered%20code%20generation%20and%20secure%20execution/1_0kzrwmxu/330865472
-
-
-
 # Openai 101
 
-> OpenAI 101 Series on using OpenAI ChatGPT, DALL·E, and other OpenAI endpoints
-
-**Focus Story**
-
-As a software developer, I want to understand OpenAI endpoints and capabilities, so that I can use ChatGPT effectively
-
-
+> OpenAI 101 working through the API endpoints
 
 ## Installation
 
@@ -38,84 +22,76 @@ Or install it yourself as:
 gem install openai_101
 ```
 
-## JavaScript Dependencies Installation
+## Stories
 
-This optional step is only required if you plan to use the JavaScript tools included in this gem from the command line.
+### Main Story
 
-[Javascript Tools]
+As a Developer, I want to understand openai/chatgpt APIs, so that I can build AI applications effectively
 
-This gem includes tools written in JavaScript, requiring Node.js and associated packages. After installing the gem, navigate to the gem's root directory and run:
+See all [stories](./STORIES.md)
 
-```bash
-npm install
-```
 
-## Resources
+## Usage
 
-- [Course Outline](./COURSE.md)
-- [OpenAI Documentation](gpt-context/openai-documentation.md) is used as reference material for code generation prompts, this information has been summarized from source documentation
-- [Ruby OpenAI Documentation](gpt-context/ruby-openai-documenation.md) is used as reference material for code generation prompts and shows examples of how to use the Ruby OpenAI gem
+See all [usage examples](./USAGE.md)
 
 
-See all [stories](./STORIES.md)
 
 ## Development
 
 Checkout the repo
 
 ```bash
-git clone https://github.com/klueless-io/openai_101
+git clone https://github.com/appydave/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.
 
-## Command line tools
-
-### Bulk MidJourney Image Generation
-
-Automates MidJourney prompts on Discord.
-
-`automate-images-midjourney`
-
-This tool will read prompts from a file and then paste them into the MidJourney Discord channel in an unattented manner. This is useful for automating the process of generating images from prompts in bulk. NOTE: You start the script and then you place the cursor in the Discord channel and the script will do the rest.
-
-### Bulk ChatGPT Image Generation
-
-Automates image prompts in ChatGPT.
-
-`automate-images-chatgpt`
-
-This tool will read prompts from a file and then paste them into the current focused ChatGPT window in unattented mode. This is useful for automating the process of generating images from prompts in bulk using the DALE-3 feature in ChatGPT Plus. NOTE: You start the script and then you place the cursor in the ChatGPT window and the script will do the rest.
+```bash
+bin/console
 
-### WEBP to PNG Converter:
+Aaa::Bbb::Program.execute()
+# => ""
+```
 
-Converts WEBP images to PNG, manages prompts.
+`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.
 
-`web3_to_png`
+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).
 
-### EDL to Chapters
+```bash
+rake publish
+rake clean
+```
 
-Converts EDL time codes to chapters in YouTube video description.
+## Git helpers used by this project
 
-`edl_to_chapters`
+Add the follow helpers to your `alias` file
 
-Usage on Mac
 ```bash
-# make the script executable
-chmod +x bin/convert_webp_to_png.rb
-
-# run the script
-./bin/convert_webp_to_png.rb -s path/to/source -t path/to/target -f target_filename -p optional_prefix
-
-# Example
-./bin/convert_webp_to_png.rb -p series-2  -f woman-grey-tabby-cat -s /Users/davidcruwys/Sync/smart-downloads/download-images
- -t /Volumes/Expansion/Sync/tube-channels/a-cast/cast-active/a35-automate-image-generation/assets
+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" }
 ```
 
-This tool automates the conversion of WEBP images to PNG format, stores associated prompts, manages source backups, and cleans up after processing.
-
 ## 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.

data/lib/openai_101/version.rb

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

data/lib/openai_101.rb

@@ -1,21 +1,10 @@
 # frozen_string_literal: true
 
-require 'clipboard'
-require 'openai'
 require 'openai_101/version'
-require 'mini_magick'
-
-require_relative 'openai_101/config/openai'
-require_relative 'openai_101/tools/webp_to_png'
-require_relative 'openai_101/tools/edl_to_chapters'
-require_relative 'openai_101/tools/file_content_gatherer'
-require_relative 'openai_101/tools/clean_ruby_errors'
 
 module Openai101
   # raise Openai101::Error, 'Sample message'
   Error = Class.new(StandardError)
-
-  # Your code goes here...
 end
 
 if ENV.fetch('KLUE_DEBUG', 'false').downcase == 'true'