walkthrough_awanllm 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6b691e6d3f1023d32733347a61c412390434b93331905aad7679335a8686b4
-  data.tar.gz: 2b765172c9465dfc2179061635f8e39d938386f3ecd40a1705e12015f4e6a874
+  metadata.gz: 34fee1262b75077f8e4c1d962798787a9998392d6d8e4adaac320001dabbc533
+  data.tar.gz: c05d2adf5e959e52a32ba1e69cd06f1eb581c4cfd02a292ab95d6f546bff9fbf
 SHA512:
-  metadata.gz: 04617cdb004d1c65a118f4e66cb222dde75f58da432240885a66f24c2892bf6192cf7dc4031e16833940aea98d6d144c04cbebd394cae933cd1523687577990f
-  data.tar.gz: 1fe5d80e013fefeba6fdb7cb2fad2ecba7261b5be15d9b8a8487007d96057c7a4696b855c006e601f0f1638f352aecbb2290c695a812419042bfd69eb25a3fb1
+  metadata.gz: b1bc27ac8a586b53618e7e8a2a38b70f747bcad9087ce539b38d68a5dc346ea2150620e98e22cd3e84cc9587a262da2cda0e92e13d5bea2f3c4c0d2934cfa791
+  data.tar.gz: 124fc7ff76f3b063ccc9d238c2516cb2abe8c2f1a9199cf1ab4181485dc1f925113a65e8a3871d83b277c558ae41656cacd04a9339fe43567f83cf55ea65b727

data/README.md

@@ -1,34 +1,74 @@
-# WalkthroughAwanllm
+Here's an updated README for your gem `walkthrough_awanllm`, including all necessary installation and usage instructions, as well as development and contributing guidelines.
 
-TODO: Delete this and the text below, and describe your gem
+```markdown
+# WalkthroughAwanllm
 
-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/walkthrough_awanllm`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby gem to generate a project development walkthrough with the AwanLLM API. This gem helps you log activities and generate detailed walkthroughs of your project's lifecycle.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'walkthrough_awanllm'
+```
+
+And then execute:
 
-Install the gem and add to the application's Gemfile by executing:
+```sh
+$ bundle install
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```sh
+$ gem install walkthrough_awanllm
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Setup
+
+After installing the gem, you need to configure it by running the setup script. This will prompt you for your AwanLLM API key and the model name you wish to use.
+
+```sh
+$ ruby ./vendor/bundle/ruby/YOUR_VERSION/gems/walkthrough_awanllm-0.1.2/bin/setup_awanllm.rb
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Generating a Walkthrough
+
+To generate a detailed walkthrough of your project's activities:
+
+```ruby
+rails console
+> awanllm = WalkthroughAwanllm::AwanLLM.new
+> awanllm.generate_walkthrough
+```
+
+This will read the activity log and generate a `walkthrough.md` file in the project's root directory.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. 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).
+To install this gem onto your local machine, run:
+
+```sh
+$ bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, and then run:
+
+```sh
+$ bundle exec rake release
+```
+
+This 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]/walkthrough_awanllm. 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]/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/mruduljohn/walkthrough_awanllm. 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/mruduljohn/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +76,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the WalkthroughAwanllm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the WalkthroughAwanllm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mruduljohn/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+```

data/Rakefile

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+
+# Load tasks defined in the lib/tasks directory
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
 task default: %i[]

data/lib/tasks/generate_walkthrough.rake

@@ -0,0 +1,8 @@
+# lib/tasks/generate_walkthrough.rake
+namespace :awanllm do
+  desc 'Generate walkthrough using AwanLLM'
+  task :generate_walkthrough => :environment do
+    awanllm = WalkthroughAwanllm::AwanLLM.new
+    awanllm.generate_walkthrough
+  end
+end

data/lib/walkthrough_awanllm/cli.rb

@@ -0,0 +1,15 @@
+# lib/walkthrough_awanllm/cli.rb
+
+require 'thor'
+
+module WalkthroughAwanllm
+  class CLI < Thor
+    desc "generate_walkthrough", "Generate the walkthrough.md file"
+    def generate_walkthrough
+      awanllm = AwanLLM.new
+      awanllm.generate_walkthrough
+      puts "Walkthrough generated successfully!"
+    end
+  end
+end
+

data/lib/walkthrough_awanllm/railtie.rb

@@ -1,3 +1,4 @@
+# lib/awanllm/railtie.rb
 
 require 'rails/railtie'
 require 'fileutils'
@@ -6,6 +7,27 @@ module AwanLLM
   class Railtie < Rails::Railtie
     initializer "awanllm.track_activity" do |app|
       app.config.middleware.use AwanLLM::Tracker
+
+      setup_git_hook
+    end
+
+    private
+
+    def setup_git_hook
+      git_hook_script_path = Rails.root.join('.git', 'hooks', 'post-commit')
+      git_hook_script_content = <<-SCRIPT
+#!/bin/bash
+RAILS_ROOT="#{Rails.root}"
+cd $RAILS_ROOT
+bundle exec rails runner "AwanLLM::Tracker.new.update_activity_log"
+      SCRIPT
+
+      # Write the Git hook script
+      File.open(git_hook_script_path, "w") { |f| f.write(git_hook_script_content) }
+      FileUtils.chmod(0755, git_hook_script_path)
+
+      # Inform the user about the setup
+      puts "Git hook for tracking activity log updates has been set up: #{git_hook_script_path}"
     end
   end
 end
@@ -13,22 +35,31 @@ end
 # Middleware to track activities
 module AwanLLM
   class Tracker
-    def initialize(app)
+    def initialize(app = nil)
       @app = app
     end
 
     def call(env)
       status, headers, response = @app.call(env)
-      log_activity(env)
       [status, headers, response]
     end
 
-    private
+    def update_activity_log
+      log_file_path = Rails.root.join('log', 'awanllm_activity.log')
+      FileUtils.mkdir_p(File.dirname(log_file_path))
+
+      # Get the latest commit details
+      commit_details = `git log -1 --pretty=format:"%H %an %ad %s" --date=iso`
+      file_changes = `git diff-tree --no-commit-id --name-status -r HEAD`
 
-    def log_activity(env)
-      FileUtils.mkdir_p("log")
-      File.open("log/awanllm_activity.log", "a") do |file|
-        file.puts("[#{Time.now}] #{env['REQUEST_METHOD']} #{env['PATH_INFO']}")
+      File.open(log_file_path, "a") do |file|
+        file.puts("### [#{Time.now}] Activity Log")
+        file.puts("#### Commit Details: #{commit_details.strip}")
+        file.puts("#### File Changes:")
+        file_changes.each_line do |line|
+          file.puts("- #{line.strip}")
+        end
+        file.puts("\n")
       end
     end
   end

data/lib/walkthrough_awanllm/version.rb

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

data/lib/walkthrough_awanllm.rb

@@ -1,83 +1,89 @@
 require 'httparty'
 require 'json'
-require 'walkthorugh_awanllm/railtie' if defined?(Rails)
+require_relative "walkthrough_awanllm/cli"
+require_relative "walkthrough_awanllm/version"
+require_relative "walkthrough_awanllm/railtie" if defined?(Rails)
 
-class AwanLLM
-  include HTTParty
-  base_uri 'https://api.awanllm.com/v1'
+module WalkthroughAwanllm
+  class AwanLLM
+    include HTTParty
+    base_uri 'https://api.awanllm.com/v1'
 
-  def initialize(api_key = nil, model_name = nil)
-    if api_key.nil? || model_name.nil?
-      config = JSON.parse(File.read("config/awanllm_config.json"))
-      @api_key = config["api_key"]
-      @model_name = config["model_name"]
-    else
-      @api_key = api_key
-      @model_name = model_name
-    end
+    def initialize(api_key = nil, model_name = nil)
+      if api_key.nil? || model_name.nil?
+        config = JSON.parse(File.read("config/awanllm_config.json"))
+        @api_key = config["api_key"]
+        @model_name = config["model_name"]
+      else
+        @api_key = api_key
+        @model_name = model_name
+      end
 
-    @headers = {
-      'Content-Type' => 'application/json',
-      'Authorization' => "Bearer #{@api_key}"
-    }
-  end
+      @headers = {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
 
-  def generate_content(messages = nil, prompt = nil, options = {})
-    payload = { model: @model_name }
-    payload[:messages] = messages if messages
-    payload[:prompt] = prompt if prompt
-    payload.merge!(options)
+    def generate_content(messages = nil, prompt = nil, options = {})
+      payload = { model: @model_name }
+      payload[:messages] = messages if messages
+      payload[:prompt] = prompt if prompt
+      payload.merge!(options)
 
-    response = self.class.post('/completions', headers: @headers, body: payload.to_json)
-    handle_response(response)
-  end
+      response = self.class.post('/completions', headers: @headers, body: payload.to_json)
+      handle_response(response)
+    end
 
-  def retrieve_content(content_id)
-    response = self.class.get("/completions/#{content_id}", headers: @headers)
-    handle_response(response)
-  end
+    def retrieve_content(content_id)
+      response = self.class.get("/completions/#{content_id}", headers: @headers)
+      handle_response(response)
+    end
 
-  def generate_walkthrough
-    activities = File.read("log/awanllm_activity.log")
-    prompt = "Here is a log of activities:\n#{activities}\nGenerate a detailed walkthrough based on these activities. It should include the steps taken and the expected outcomes."
+    def generate_walkthrough
+      activities = File.read("log/awanllm_activity.log")
+      prompt = "Here is a log of activities:\n#{activities}\nGenerate a detailed walkthrough based on these activities. It should include the steps taken and the expected outcomes."
 
-    options = {
-      temperature: 0.7,
-      top_p: 0.9,
-      max_tokens: 1024
-    }
+      options = {
+        temperature: 0.7,
+        top_p: 0.9,
+        max_tokens: 1024
+      }
 
-    response = generate_content(nil, prompt, options)
-    walkthrough = response['choices'][0]['text']
+      response = generate_content(nil, prompt, options)
+      walkthrough = response['choices'][0]['text']
 
-    File.open("walkthrough.md", "w") do |file|
-      file.write(walkthrough)
+      File.open("walkthrough.md", "w") do |file|
+        file.write(walkthrough)
+      end
     end
-  end
 
-  def self.activate!
-    require 'fileutils'
-    require 'json'
+    def self.activate!
+      require 'fileutils'
+      require 'json'
 
-    # Run the installation script
-    if File.exist?('config/awanllm_config.json')
-      puts 'Walkthrough_AwanLLM gem is already configured.'
-    else
-      system('ruby setup_awanllm')
+      # Run the installation script
+      if File.exist?('config/awanllm_config.json')
+        puts 'Walkthrough_AwanLLM gem is already configured.'
+      else
+        ruby_version = RUBY_VERSION.split('.').first(3).join('.')
+        path_to_script = "./vendor/bundle/ruby/#{ruby_version}/gems/walkthrough_awanllm-0.1.2/bin/setup_awanllm.rb"
+        system("ruby #{path_to_script}")
+      end
     end
-  end
 
-  # Activate the gem automatically after installation
-  activate!
+    # Activate the gem automatically after installation
+    activate!
 
-  private
+    private
 
-  def handle_response(response)
-    if response.success?
-      JSON.parse(response.body)
-    else
-      error_message = JSON.parse(response.body)['error']['message'] rescue response.message
-      raise "Error: #{response.code} - #{error_message}"
+    def handle_response(response)
+      if response.success?
+        JSON.parse(response.body)
+      else
+        error_message = JSON.parse(response.body)['error']['message'] rescue response.message
+        raise "Error: #{response.code} - #{error_message}"
+      end
     end
   end
 end

data/walkthrough_awanllm.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/walkthrough_awanllm/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "walkthrough_awanllm"
+  spec.version     = WalkthroughAwanllm::VERSION
+  spec.authors     = ["Mrudul John"]
+  spec.email       = ["mrudulmathews@gmail.com"]
+
+  spec.summary     = "A Ruby gem to Generate Project Development Walkthrough with the AwanLLM API."
+  spec.description = "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM API for generating and retrieving content."
+  spec.homepage    = "https://github.com/mruduljohn/Walkthrough_awanllm_gem"
+  spec.license     = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile]) ||
+      f.match(/walkthrough_awanllm-\d+\.\d+\.\d+\.gem/)
+    end
+  end + [
+    "lib/walkthrough_awanllm.rb",
+    "lib/walkthrough_awanllm/railtie.rb",
+    "lib/walkthrough_awanllm/version.rb",
+    "bin/setup_awanllm.rb", # Include setup_awanllm.rb file
+    "lib/tasks/generate_walkthrough.rake", # Include generate_walkthrough.rake file
+  ]
+
+  spec.bindir = "bin"
+  spec.executables = ["setup_awanllm.rb"]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "httparty"
+  spec.add_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.post_install_message = <<-MESSAGE
+    Thank you for installing the Walkthrough_AwanLLM gem!
+    To complete the setup, please run the following command:
+    ruby ./vendor/bundle/ruby/#{RUBY_VERSION.split('.').first(3).join('.')}/gems/walkthrough_awanllm-#{spec.version}/bin/setup_awanllm.rb
+  MESSAGE
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: walkthrough_awanllm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mrudul John
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,11 +80,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM
-  API for generating and retrieving content.
+description: "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough
+  the project lifecycle with the AwanLLM API for generating and retrieving content."
 email:
 - mrudulmathews@gmail.com
-executables: []
+executables:
+- setup_awanllm.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,19 +95,22 @@ files:
 - README.md
 - Rakefile
 - bin/setup_awanllm.rb
+- lib/tasks/generate_walkthrough.rake
 - lib/walkthrough_awanllm.rb
+- lib/walkthrough_awanllm/cli.rb
 - lib/walkthrough_awanllm/railtie.rb
 - lib/walkthrough_awanllm/version.rb
 - sig/walkthrough_awanllm.rbs
+- walkthrough_awanllm.gemspec
 homepage: https://github.com/mruduljohn/Walkthrough_awanllm_gem
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/mruduljohn/Walkthrough_awanllm_gem
 post_install_message: |2
-      Thank you for installing the AwanLLM gem!
+      Thank you for installing the Walkthrough_AwanLLM gem!
       To complete the setup, please run the following command:
-      ruby setup_awanllm.rb
+      ruby ./vendor/bundle/ruby/3.3.0/gems/walkthrough_awanllm-0.1.2/bin/setup_awanllm.rb
 rdoc_options: []
 require_paths:
 - lib
@@ -110,5 +128,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: A Ruby gem to Generate Project Development Walthrough with the AwanLLM API.
+summary: A Ruby gem to Generate Project Development Walkthrough with the AwanLLM API.
 test_files: []