thecompaniesapi 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc866d01cf2643f8ba16a54921ad746373a48d605ef0940c90a4445c5181ed27
+  data.tar.gz: 2a5e853a52d10e288bd257d15c03fcffcbb58c22b8941f8db5a6c295f78e9d1b
+SHA512:
+  metadata.gz: e836f3f983d31394b9ce3d96e5c4d78f10347209a42e3d7b92656bcff21d763d1018bde1810bd56f3be99e5e5e63c52c33ff87a128eb671449f88460e8d82946
+  data.tar.gz: f4295013c604a6374b61d5b2e8e03014f963808a35c1678e62efe516a0f7c3510a9fe506bf48e70b4b0e4f76b4f32fa430e1ad39a81bd9cbcdc071f81c5ec847

data/.env.example

@@ -0,0 +1,4 @@
+TCA_API_TOKEN=your-api-token-here
+TCA_API_URL=https://api.thecompaniesapi.com
+TCA_VISITOR_ID=your-visitor-id
+TCA_TIMEOUT=30

data/.github/workflows/release.yml

@@ -0,0 +1,106 @@
+name: Release & Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    name: Publish to RubyGems
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: false
+    
+    - name: Configure Bundler
+      run: |
+        bundle config set --local path 'vendor/bundle'
+        bundle config set --local deployment 'false'
+        bundle config set --local frozen 'false'
+    
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+    
+    - name: Run tests
+      env:
+        TCA_API_TOKEN: ${{ secrets.TCA_API_TOKEN }}
+      run: bundle exec rake test
+    
+    - name: Build gem
+      run: gem build thecompaniesapi.gemspec
+    
+    - name: Extract version
+      id: extract_version
+      run: |
+        VERSION=${GITHUB_REF#refs/tags/}
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+        echo "clean_version=${VERSION#v}" >> $GITHUB_OUTPUT
+    
+    - name: Validate gem version matches tag
+      run: |
+        GEM_VERSION=$(ruby -e "require './lib/thecompaniesapi/version'; puts TheCompaniesAPI::VERSION")
+        TAG_VERSION="${{ steps.extract_version.outputs.clean_version }}"
+        if [ "$GEM_VERSION" != "$TAG_VERSION" ]; then
+          echo "❌ Gem version ($GEM_VERSION) doesn't match tag version ($TAG_VERSION)"
+          exit 1
+        fi
+        echo "✅ Gem version matches tag version: $GEM_VERSION"
+    
+    - name: Publish to RubyGems
+      env:
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+      run: |
+        if [ -n "$RUBYGEMS_API_KEY" ]; then
+          echo "Publishing gem to RubyGems..."
+          mkdir -p ~/.gem
+          echo ":rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          gem push thecompaniesapi-${{ steps.extract_version.outputs.clean_version }}.gem
+          echo "✅ Gem published successfully to RubyGems"
+        else
+          echo "⚠️ RubyGems API key not found. Skipping gem publication."
+        fi
+    
+    - name: Create Release
+      uses: softprops/action-gh-release@v1
+      with:
+        tag_name: ${{ steps.extract_version.outputs.version }}
+        name: Release ${{ steps.extract_version.outputs.version }}
+        body: |
+          ## 🚀 Release ${{ steps.extract_version.outputs.version }}
+          
+          ### 📦 Installation
+          
+          ```ruby
+          gem 'thecompaniesapi', '~> ${{ steps.extract_version.outputs.clean_version }}'
+          ```
+          
+          Or install directly:
+          
+          ```bash
+          gem install thecompaniesapi -v ${{ steps.extract_version.outputs.clean_version }}
+          ```
+          
+          ### 📋 What's Changed
+          
+          See the [commit history](https://github.com/${{ github.repository }}/commits/${{ steps.extract_version.outputs.version }}) for detailed changes.
+          
+          ### 🔗 Links
+          
+          - 📖 [Documentation](https://github.com/${{ github.repository }}#readme)
+          - 💎 [RubyGems Package](https://rubygems.org/gems/thecompaniesapi)
+          - 🌐 [The Companies API](https://www.thecompaniesapi.com)
+          - 📚 [API Documentation](https://www.thecompaniesapi.com/api)
+        draft: false
+        prerelease: false
+        generate_release_notes: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 

data/.github/workflows/tests.yml

@@ -0,0 +1,93 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+    
+    name: Test Ruby ${{ matrix.ruby-version }}
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false  # Disable auto cache to handle manually
+    
+    - name: Configure Bundler
+      run: |
+        bundle config set --local path 'vendor/bundle'
+        bundle config set --local deployment 'false'
+        bundle config set --local frozen 'false'
+    
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+    
+    - name: Validate gemspec
+      run: gem build thecompaniesapi.gemspec
+    
+    - name: Check syntax
+      run: |
+        find lib test -name "*.rb" -exec ruby -c {} \;
+    
+    - name: Run unit tests
+      run: bundle exec rake test:unit
+    
+    - name: Run integration tests
+      env:
+        TCA_API_TOKEN: ${{ secrets.TCA_API_TOKEN }}
+      run: bundle exec rake test:integration
+    
+    - name: Check code style (if RuboCop is available)
+      run: |
+        if bundle list | grep -q rubocop; then
+          bundle exec rubocop
+        else
+          echo "RuboCop not found, skipping style check"
+        fi
+      continue-on-error: true
+
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint & Security
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: false
+    
+    - name: Configure Bundler
+      run: |
+        bundle config set --local path 'vendor/bundle'
+        bundle config set --local deployment 'false'
+        bundle config set --local frozen 'false'
+    
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+    
+    - name: Check for security vulnerabilities
+      run: |
+        if bundle list | grep -q bundler-audit; then
+          bundle exec bundler-audit --update
+        else
+          echo "bundler-audit not found, skipping security check"
+        fi
+      continue-on-error: true
+    
+    - name: Check for outdated gems
+      run: bundle outdated
+      continue-on-error: true 

data/.gitignore

@@ -0,0 +1,146 @@
+# Gem artifacts
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Documentation cache and generated files
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment configuration
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# For a library or gem, add the lock file to git, but for applications, 
+# it's better to not commit it
+# Gemfile.lock
+
+# Unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# RuboCop cache
+.rubocop-cache/
+
+# Ruby version files
+.ruby-version
+.ruby-gemset
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Keep .env.example for documentation
+!.env.example
+
+# IDE and editor files
+/.vscode/
+/.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+public
+
+# Storybook build outputs
+.out
+.storybook-out
+
+# Temporary folders
+tmp/
+temp/
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Additional Ruby patterns
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# SimpleCov
+coverage
+
+# RSpec
+.rspec_status 

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 tavo@hey.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in thecompaniesapi.gemspec
+gemspec
+
+gem "rake", "~> 13.0.6"
+gem "minitest", "~> 5.16.3"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    thecompaniesapi (1.0.1)
+      faraday (~> 2.0)
+      faraday-net_http (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.8.1)
+    faraday (2.13.3)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    json (2.13.0)
+    logger (1.7.0)
+    minitest (5.16.3)
+    net-http (0.6.0)
+      uri
+    rake (13.0.6)
+    uri (1.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv (~> 2.8)
+  minitest (~> 5.16.3)
+  rake (~> 13.0.6)
+  thecompaniesapi!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 The Companies API SARL
+
+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.