petstore_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2807ed8c8d8182bc30d54bc1b5ac995f328c72b32fee7749db6cb1b68ef613ea
+  data.tar.gz: 4e34e6e5e0180e4f3161910931849e7c77f48467ab079cda832c5d2944a85f2d
+SHA512:
+  metadata.gz: 18af185433ce4e77b55660dd01ac43436339b95f8366c75f6c32676a95a8319991b8481c623fdb1c84b8ddec8e1e009558a53b1bdc5dcd23b52df29d1d138eb7
+  data.tar.gz: '0847eb04e3dbc161026ca7e3bfbb2634ead1b9a967560c45900a462fed09fd4b3575be17326614aef5b29d86d17bd8b9152ef269f844dd186fd1a4f5ff8346c3'

data/.editorconfig

@@ -0,0 +1,33 @@
+# EditorConfig helps maintain consistent coding styles
+# See https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Gemfile]
+indent_style = space
+indent_size = 2
+
+[Rakefile]
+indent_style = space
+indent_size = 2
+
+[*.gemspec]
+indent_style = space
+indent_size = 2

data/.env.example

@@ -0,0 +1,50 @@
+# Petstore API Client - Environment Variables Example
+# Copy this file to .env and fill in your actual credentials
+# IMPORTANT: Never commit .env file to git!
+
+# ============================================
+# API Configuration
+# ============================================
+PETSTORE_BASE_URL=https://petstore.swagger.io/v2
+
+# ============================================
+# Authentication - Choose ONE strategy
+# ============================================
+
+# Strategy 1: API Key Authentication (default)
+# Uncomment to use API key auth:
+# PETSTORE_API_KEY=special-key
+
+# Strategy 2: OAuth2 Authentication
+# Uncomment to use OAuth2 auth:
+# PETSTORE_OAUTH2_CLIENT_ID=your-client-id
+# PETSTORE_OAUTH2_CLIENT_SECRET=your-client-secret
+# PETSTORE_OAUTH2_TOKEN_URL=https://petstore.swagger.io/oauth/token
+# PETSTORE_OAUTH2_SCOPE=read:pets write:pets
+
+# Strategy 3: Both API Key + OAuth2
+# Uncomment both sections above to send both headers
+
+# Strategy 4: No Authentication
+# Leave all auth variables commented out
+
+# ============================================
+# Client Configuration
+# ============================================
+PETSTORE_TIMEOUT=30
+PETSTORE_OPEN_TIMEOUT=10
+PETSTORE_RETRY_ENABLED=true
+PETSTORE_MAX_RETRIES=2
+
+# ============================================
+# Pagination
+# ============================================
+PETSTORE_DEFAULT_PAGE_SIZE=25
+PETSTORE_MAX_PAGE_SIZE=100
+
+# ============================================
+# Development/Testing
+# ============================================
+# RAILS_ENV=development
+# RACK_ENV=development
+DEBUG=false

data/.github/CODEOWNERS

@@ -0,0 +1,36 @@
+# Code Owners for Petstore API Client
+# These users will be automatically requested for review when PRs are opened
+
+# Default owners for everything in the repo
+* @hammadxcm
+
+# Authentication system
+/lib/petstore_api_client/authentication/ @hammadxcm
+/spec/authentication/ @hammadxcm
+
+# Core API client
+/lib/petstore_api_client/client.rb @hammadxcm
+/lib/petstore_api_client/api_client.rb @hammadxcm
+/lib/petstore_api_client/configuration.rb @hammadxcm
+
+# Models
+/lib/petstore_api_client/models/ @hammadxcm
+/spec/models/ @hammadxcm
+
+# Client endpoints
+/lib/petstore_api_client/clients/ @hammadxcm
+/spec/clients/ @hammadxcm
+
+# CI/CD and configuration
+/.github/ @hammadxcm
+/Gemfile @hammadxcm
+/petstore_api_client.gemspec @hammadxcm
+/.rubocop.yml @hammadxcm
+
+# Documentation
+/README.md @hammadxcm
+/CONTRIBUTORS.md @hammadxcm
+
+# Security-sensitive files
+/.gitignore @hammadxcm
+/.env.example @hammadxcm

data/.github/workflows/ci.yml

@@ -0,0 +1,157 @@
+# Petstore API Client - CI/CD Pipeline
+# Author: Hammad Khan (@hammadxcm)
+# Repository: https://github.com/hammadxcm/petstore-api-client
+
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+  workflow_dispatch:  # Allow manual trigger
+
+jobs:
+  test:
+    name: Tests (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3']
+
+    steps:
+    - name: 📥 Checkout code
+      uses: actions/checkout@v4
+
+    - name: 💎 Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: 📦 Install dependencies
+      run: bundle install --jobs 4 --retry 3
+
+    - name: 🧪 Run tests
+      run: bundle exec rspec
+
+    - name: 📊 Upload coverage (Ruby 3.3 only)
+      if: matrix.ruby == '3.3'
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-report
+        path: coverage/
+
+  lint:
+    name: RuboCop
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: 📥 Checkout code
+      uses: actions/checkout@v4
+
+    - name: 💎 Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: 📦 Install dependencies
+      run: bundle install --jobs 4 --retry 3
+
+    - name: 🔍 Run RuboCop
+      run: bundle exec rubocop
+
+  security:
+    name: Security Audit
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: 📥 Checkout code
+      uses: actions/checkout@v4
+
+    - name: 💎 Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: 🔒 Run bundle audit
+      run: |
+        gem install bundler-audit
+        bundle audit check --update
+
+  build:
+    name: Build Gem
+    runs-on: ubuntu-latest
+    needs: [test, lint]
+
+    steps:
+    - name: 📥 Checkout code
+      uses: actions/checkout@v4
+
+    - name: 💎 Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: 📦 Build gem
+      run: gem build petstore_api_client.gemspec
+
+    - name: 📤 Upload gem artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: petstore-api-client-gem
+        path: '*.gem'
+
+  coverage:
+    name: Coverage Report
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+    - name: 📥 Checkout code
+      uses: actions/checkout@v4
+
+    - name: 💎 Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: 📦 Install dependencies
+      run: bundle install
+
+    - name: 🧪 Run tests with coverage
+      run: bundle exec rspec
+
+    - name: 📊 Check coverage threshold
+      run: |
+        COVERAGE=$(ruby -e "require 'json'; data = JSON.parse(File.read('coverage/.last_run.json')); puts data['result']['line']")
+        echo "Coverage: $COVERAGE%"
+        if (( $(echo "$COVERAGE < 95" | bc -l) )); then
+          echo "❌ Coverage $COVERAGE% is below 95% threshold"
+          exit 1
+        fi
+        echo "✅ Coverage $COVERAGE% meets threshold"
+
+  report:
+    name: Test Summary
+    runs-on: ubuntu-latest
+    needs: [test, lint, security, build, coverage]
+    if: always()
+
+    steps:
+    - name: 📋 Generate summary
+      run: |
+        echo "## 🎯 CI/CD Pipeline Results" >> $GITHUB_STEP_SUMMARY
+        echo "" >> $GITHUB_STEP_SUMMARY
+        echo "| Job | Status |" >> $GITHUB_STEP_SUMMARY
+        echo "|-----|--------|" >> $GITHUB_STEP_SUMMARY
+        echo "| Tests | ${{ needs.test.result == 'success' && '✅ Passed' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| Linting | ${{ needs.lint.result == 'success' && '✅ Passed' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| Security | ${{ needs.security.result == 'success' && '✅ Passed' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| Build | ${{ needs.build.result == 'success' && '✅ Passed' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| Coverage | ${{ needs.coverage.result == 'success' && '✅ Passed' || '❌ Failed' }} |" >> $GITHUB_STEP_SUMMARY

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CONTRIBUTORS.md

@@ -0,0 +1,39 @@
+# Contributors
+
+## 👨‍💻 Core Maintainer
+
+**Hammad Khan** ([@hammadxcm](https://github.com/hammadxcm))
+- 🏗️ Project architect and lead developer
+- 🔐 OAuth2 authentication system
+- 🧪 Test suite (454 tests, 96.91% coverage)
+- 📚 Documentation and guides
+- 🔄 CI/CD pipeline setup
+
+## 🌟 How to Contribute
+
+We welcome contributions from the community!
+
+**Getting Started:**
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Write tests for your changes
+4. Ensure all tests pass (`bundle exec rspec`)
+5. Run linter (`bundle exec rubocop`)
+6. Commit your changes
+7. Push to your fork and create a Pull Request
+
+All contributions should maintain the existing code quality standards and include appropriate tests.
+
+## 📜 Code of Conduct
+
+We are committed to providing a welcoming and inspiring community for all. Please be respectful and constructive.
+
+## 🙏 Acknowledgments
+
+- Built with inspiration from industry-standard gems like [Octokit](https://github.com/octokit/octokit.rb) and [Slack Ruby Client](https://github.com/slack-ruby/slack-ruby-client)
+- OAuth2 implementation follows [OAuth 2.0 RFC 6749](https://tools.ietf.org/html/rfc6749)
+- Petstore API by [Swagger/OpenAPI](https://petstore.swagger.io/)
+
+---
+
+**Want to be listed here?** Submit a Pull Request! All contributions are appreciated. 🎉

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Petstore API Client Contributors
+
+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.