universal_document_processor 1.0.0

data/GEM_RELEASE_GUIDE.md

@@ -0,0 +1,288 @@
+# 🚀 Universal Document Processor - Gem Release Guide
+
+## Overview
+
+This guide will walk you through the complete process of releasing your Universal Document Processor gem through GitHub and publishing it to RubyGems.
+
+## 📋 Prerequisites
+
+1. **GitHub Account**: Make sure you have a GitHub account
+2. **RubyGems Account**: Create an account at [rubygems.org](https://rubygems.org)
+3. **Git**: Ensure Git is installed and configured
+4. **Ruby**: Ruby 2.7+ installed
+5. **Bundler**: Latest version of Bundler
+
+## 🛠️ Step-by-Step Release Process
+
+### Step 1: Prepare Your Local Repository
+
+```bash
+# Navigate to your gem directory
+cd universal_document_processor
+
+# Check current status
+git status
+
+# Add all files to git
+git add .
+
+# Commit your changes
+git commit -m "Initial gem setup with AI features"
+
+# Check your remote origin (should point to GitHub)
+git remote -v
+```
+
+### Step 2: Create GitHub Repository
+
+1. **Go to GitHub**: Visit [github.com](https://github.com)
+2. **Create New Repository**:
+   - Repository name: `universal_document_processor`
+   - Description: "Universal document processor with AI capabilities for all file formats"
+   - Make it **Public** (required for gem publishing)
+   - Don't initialize with README (you already have one)
+
+3. **Add GitHub as remote origin**:
+```bash
+# Replace YOUR_USERNAME with your actual GitHub username
+git remote add origin https://github.com/YOUR_USERNAME/universal_document_processor.git
+
+# Or if you already have origin set, update it:
+git remote set-url origin https://github.com/YOUR_USERNAME/universal_document_processor.git
+```
+
+### Step 3: Push to GitHub
+
+```bash
+# Push to GitHub
+git branch -M main
+git push -u origin main
+```
+
+### Step 4: Set Up RubyGems Account
+
+1. **Create RubyGems Account**: Visit [rubygems.org](https://rubygems.org) and sign up
+2. **Get API Key**: 
+   - Go to your profile → "Edit Profile" → "API Keys"
+   - Create a new API key with appropriate permissions
+3. **Configure local gem credentials**:
+```bash
+# This will prompt for your RubyGems.org credentials
+gem push --help
+```
+
+### Step 5: Build and Test Your Gem Locally
+
+```bash
+# Install dependencies
+bundle install
+
+# Build the gem
+gem build universal_document_processor.gemspec
+
+# Test installation locally
+gem install ./universal_document_processor-1.0.0.gem
+
+# Test that it works
+ruby -e "require 'universal_document_processor'; puts 'Gem loaded successfully!'"
+```
+
+### Step 6: Publish to RubyGems
+
+```bash
+# Push the gem to RubyGems
+gem push universal_document_processor-1.0.0.gem
+```
+
+If successful, you'll see:
+```
+Pushing gem to https://rubygems.org...
+Successfully registered gem: universal_document_processor (1.0.0)
+```
+
+### Step 7: Create GitHub Release
+
+1. **Go to your GitHub repository**
+2. **Click "Releases"** → **"Create a new release"**
+3. **Fill in the details**:
+   - **Tag version**: `v1.0.0`
+   - **Release title**: `Universal Document Processor v1.0.0`
+   - **Description**: Copy from your CHANGELOG.md
+4. **Publish release**
+
+### Step 8: Update Repository Links
+
+Update your gemspec file with the correct GitHub URLs:
+
+```ruby
+# In universal_document_processor.gemspec
+spec.homepage = "https://github.com/YOUR_USERNAME/universal_document_processor"
+spec.metadata = {
+  "homepage_uri"      => "https://github.com/YOUR_USERNAME/universal_document_processor",
+  "source_code_uri"   => "https://github.com/YOUR_USERNAME/universal_document_processor",
+  "bug_tracker_uri"   => "https://github.com/YOUR_USERNAME/universal_document_processor/issues",
+  # ... other metadata
+}
+```
+
+## 🔄 Future Updates and Versioning
+
+### Semantic Versioning
+
+Follow [Semantic Versioning](https://semver.org/):
+- **MAJOR** (1.0.0 → 2.0.0): Breaking changes
+- **MINOR** (1.0.0 → 1.1.0): New features, backward compatible
+- **PATCH** (1.0.0 → 1.0.1): Bug fixes, backward compatible
+
+### Release Process for Updates
+
+1. **Update version** in `lib/universal_document_processor/version.rb`:
+```ruby
+module UniversalDocumentProcessor
+  VERSION = "1.1.0"
+end
+```
+
+2. **Update CHANGELOG.md** with new changes
+
+3. **Commit and tag**:
+```bash
+git add .
+git commit -m "Release v1.1.0"
+git tag v1.1.0
+git push origin main --tags
+```
+
+4. **Build and publish**:
+```bash
+gem build universal_document_processor.gemspec
+gem push universal_document_processor-1.1.0.gem
+```
+
+5. **Create GitHub Release** for the new version
+
+## 🛡️ Security Best Practices
+
+### 1. Enable MFA on RubyGems
+```bash
+# Enable two-factor authentication
+gem owner --add your@email.com --otp 123456
+```
+
+### 2. Secure API Keys
+- Never commit API keys to the repository
+- Use environment variables for sensitive data
+- Add `.env` files to `.gitignore`
+
+### 3. Gem Signing (Optional but Recommended)
+```bash
+# Create a self-signed certificate
+gem cert --build your@email.com
+
+# Sign your gem
+gem build universal_document_processor.gemspec --sign
+```
+
+## 📊 GitHub Actions for Automated Testing (Optional)
+
+Create `.github/workflows/ci.yml`:
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    
+    - name: Run tests
+      run: bundle exec rspec
+    
+    - name: Run rubocop
+      run: bundle exec rubocop
+```
+
+## 🎯 Post-Release Checklist
+
+- [ ] Gem is available on [rubygems.org](https://rubygems.org)
+- [ ] GitHub repository is public and accessible
+- [ ] README.md is comprehensive and up-to-date
+- [ ] CHANGELOG.md reflects all changes
+- [ ] License file is present
+- [ ] GitHub release is created with proper tags
+- [ ] Links in gemspec point to correct repositories
+- [ ] Documentation is clear for users
+
+## 📈 Promotion and Marketing
+
+### 1. Announce Your Gem
+- Write a blog post about your gem
+- Share on social media (Twitter, LinkedIn)
+- Post in Ruby communities and forums
+- Submit to Ruby newsletter curators
+
+### 2. Documentation
+- Create detailed documentation using YARD
+- Add code examples and tutorials
+- Create video demonstrations
+
+### 3. Community Engagement
+- Respond to issues and pull requests promptly
+- Maintain active development
+- Gather user feedback and iterate
+
+## 🆘 Troubleshooting
+
+### Common Issues
+
+1. **"Permission denied" when pushing to RubyGems**
+   - Check your API credentials
+   - Ensure you have push permissions
+   - Verify gem name isn't already taken
+
+2. **Git push rejected**
+   - Pull latest changes: `git pull origin main`
+   - Resolve any conflicts
+   - Try push again
+
+3. **Gem build fails**
+   - Check gemspec syntax
+   - Ensure all required files are present
+   - Verify Ruby version compatibility
+
+4. **GitHub repository access issues**
+   - Check repository visibility (should be public)
+   - Verify SSH keys or access tokens
+   - Ensure correct remote URL
+
+## 📞 Support
+
+If you encounter issues during the release process:
+
+1. **Check the logs**: Most tools provide detailed error messages
+2. **GitHub Documentation**: [GitHub Docs](https://docs.github.com)
+3. **RubyGems Guides**: [RubyGems.org Guides](https://guides.rubygems.org)
+4. **Ruby Community**: Stack Overflow, Reddit r/ruby
+
+---
+
+**Congratulations! Your gem is now live and available to the Ruby community! 🎉**
+
+Remember to maintain your gem regularly, respond to user feedback, and keep it updated with new features and bug fixes. 

data/Gemfile

@@ -0,0 +1,27 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in universal_document_processor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development do
+  gem "rspec", "~> 3.12"
+  gem "rubocop", "~> 1.50"
+  gem "yard", "~> 0.9"
+  gem "bundler", "~> 2.0"
+end
+
+group :test do
+  gem "simplecov", "~> 0.22"
+  gem "webmock", "~> 3.18"
+end
+
+# Optional dependencies for enhanced functionality
+# Uncomment these if you want them available during development
+# gem "pdf-reader", "~> 2.0"
+# gem "prawn", "~> 2.4"
+# gem "docx", "~> 0.8"
+# gem "roo", "~> 2.8"
+# gem "mini_magick", "~> 4.11"
+# gem "yomu", "~> 0.2" 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vikas Patil
+
+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.