cufinder-ruby 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f06c87746a02b9f3ba1003f43e859f96549c67061db0d66465ce919324400f
-  data.tar.gz: e304713de973c2cfa7de842e9788a2d49a17383dc540a9c7520ff6205f50dfcd
+  metadata.gz: 5f02342f587a60dcb5946f69fce0aab002736425ead7614d5cecaca4af35d035
+  data.tar.gz: '097b09d59e662d36c221de3fcc9bda06ebc0778c84daf291fb12f7047dd3f549'
 SHA512:
-  metadata.gz: 65e625f7ac41c7b61af9b3f672d5a4c9cae6243a28a62c099feb13dc8bfecefd3c388790d355c5b6c7a47ec544676ccee0da857b89a23d7fc8de05ef745ab7d6
-  data.tar.gz: a35579b44987e8aa8c2bb5a8ecad07da0c6dc4585cf3c0a08626b2202253e77da1b60000e7d6481bac5c11e906c84e8bba3e61685fddc008efd90ca4555eeb5b
+  metadata.gz: bc1ee47853ec78af1f478410b7ed54dc0dcb024d918cf0f32e145084f621751326a4f878b7ff4ec22029f39efcccb5b1e4fa0b386a42ae8bd2cc5aa937f85df4
+  data.tar.gz: 469e8cd28fc6308b2768ffcda28a350397604908ae3ebfedc531b24c76e8a067be905f0deddad258894825f4155acd7554d131d1637cf9ee6393d1b3514ec0a7

data/README.md

@@ -1,6 +1,6 @@
-# CUFinder Ruby SDK
+# CUFinder Ruby Client
 
-Official Ruby SDK for accessing CUFinder's comprehensive business intelligence and lead generation services.
+Official Ruby Client for accessing CUFinder's comprehensive business intelligence and lead generation services.
 
 ## Installation
 
@@ -29,178 +29,163 @@ gem install cufinder-ruby
 ```ruby
 require 'cufinder_ruby'
 
-# Initialize the SDK with your API key
-sdk = CufinderRuby::SDK.new(api_key: 'your-api-key-here')
+# Initialize the client with your API key
+client = Cufinder::Client.new(api_key: 'your-api-key-here')
 ```
 
 ### Available Services
 
-The SDK provides access to all CUFinder API services:
+The Client provides access to all CUFinder API services:
 
 #### 1. CUF - Company URL Finder
 ```ruby
-result = sdk.cuf(company_name: "Apple Inc", country_code: "US")
+result = client.cuf(company_name: "Apple Inc", country_code: "US")
 puts result.domain  # => "apple.com"
 ```
 
 #### 2. LCUF - LinkedIn Company URL Finder
 ```ruby
-result = sdk.lcuf(company_name: "Apple Inc")
+result = client.lcuf(company_name: "Apple Inc")
 puts result.linkedin_url  # => "linkedin.com/company/apple"
 ```
 
 #### 3. DTC - Domain to Company
 ```ruby
-result = sdk.dtc(company_website: "apple.com")
+result = client.dtc(company_website: "apple.com")
 puts result.company_name  # => "Apple Inc"
 ```
 
 #### 4. DTE - Domain to Emails
 ```ruby
-result = sdk.dte(company_website: "apple.com")
+result = client.dte(company_website: "apple.com")
 puts result.emails  # => ["contact@apple.com", "info@apple.com"]
 ```
 
 #### 5. NTP - Name to Phones
 ```ruby
-result = sdk.ntp(company_name: "Apple Inc")
+result = client.ntp(company_name: "Apple Inc")
 puts result.phones  # => ["+1-408-996-1010"]
 ```
 
 #### 6. REL - Reverse Email Lookup
 ```ruby
-result = sdk.rel(email: "tim.cook@apple.com")
+result = client.rel(email: "tim.cook@apple.com")
 puts result.person.full_name  # => "Tim Cook"
 ```
 
 #### 7. FCL - Find Company Lookalikes
 ```ruby
-result = sdk.fcl(query: "tech startup")
+result = client.fcl(query: "tech startup")
 puts result.companies.length  # => 10
 ```
 
 #### 8. ELF - Enrich LinkedIn Fundraising
 ```ruby
-result = sdk.elf(query: "tech company")
+result = client.elf(query: "tech company")
 puts result.fundraising.funding_money_raised  # => "$5M"
 ```
 
 #### 9. CAR - Company Annual Revenue
 ```ruby
-result = sdk.car(query: "Apple Inc")
+result = client.car(query: "Apple Inc")
 puts result.revenue  # => "$394.3B"
 ```
 
 #### 10. FCC - Find Company Children
 ```ruby
-result = sdk.fcc(query: "Apple Inc")
+result = client.fcc(query: "Apple Inc")
 puts result.subsidiaries  # => ["Beats Electronics", "Shazam"]
 ```
 
 #### 11. FTS - Find Tech Stack
 ```ruby
-result = sdk.fts(query: "web development")
+result = client.fts(query: "web development")
 puts result.technologies  # => ["React", "Node.js", "Python"]
 ```
 
 #### 12. EPP - Enrich Person Profile
 ```ruby
-result = sdk.epp(linkedin_url: "linkedin.com/in/tim-cook")
+result = client.epp(linkedin_url: "linkedin.com/in/tim-cook")
 puts result.person.full_name  # => "Tim Cook"
 ```
 
 #### 13. FWE - Find Work Email
 ```ruby
-result = sdk.fwe(linkedin_url: "linkedin.com/in/tim-cook")
+result = client.fwe(linkedin_url: "linkedin.com/in/tim-cook")
 puts result.email  # => "tim.cook@apple.com"
 ```
 
 #### 14. TEP - Title Email Phone
 ```ruby
-result = sdk.tep(full_name: "Tim Cook", company: "Apple Inc")
+result = client.tep(full_name: "Tim Cook", company: "Apple Inc")
 puts result.person.email  # => "tim.cook@apple.com"
 puts result.person.phone  # => "+1-408-996-1010"
 ```
 
 #### 15. ENC - Enrich Company
 ```ruby
-result = sdk.enc(query: "Apple Inc")
+result = client.enc(query: "Apple Inc")
 puts result.company.employee_count  # => 164000
 ```
 
 #### 16. CEC - Company Employee Count
 ```ruby
-result = sdk.cec(query: "Apple Inc")
+result = client.cec(query: "Apple Inc")
 puts result.countries  # => {"US" => 100000, "CA" => 5000}
 ```
 
 #### 17. CLO - Company Locations
 ```ruby
-result = sdk.clo(query: "Apple Inc")
+result = client.clo(query: "Apple Inc")
 puts result.locations.first.city  # => "Cupertino"
 ```
 
 #### 18. CSE - Company Search Engine
 ```ruby
-result = sdk.cse(name: "tech", country: "US", industry: "software")
+result = client.cse(name: "tech", country: "US", industry: "software")
 puts result.companies.length  # => 50
 ```
 
 #### 19. PSE - Person Search Engine
 ```ruby
-result = sdk.pse(full_name: "John", country: "US", company_name: "Apple")
+result = client.pse(full_name: "John", country: "US", company_name: "Apple")
 puts result.peoples.length  # => 25
 ```
 
 #### 20. LBS - Local Business Search
 ```ruby
-result = sdk.lbs(name: "restaurant", city: "New York")
+result = client.lbs(name: "restaurant", city: "New York")
 puts result.companies.length  # => 100
 ```
 
 ### Error Handling
 
-The SDK provides comprehensive error handling:
+The Client provides comprehensive error handling:
 
 ```ruby
 begin
-  result = sdk.cuf(company_name: "Apple Inc", country_code: "US")
-rescue CufinderRuby::AuthenticationError => e
+  result = client.cuf(company_name: "Apple Inc", country_code: "US")
+rescue Cufinder::AuthenticationError => e
   puts "Authentication failed: #{e.message}"
-rescue CufinderRuby::RateLimitError => e
+rescue Cufinder::RateLimitError => e
   puts "Rate limit exceeded: #{e.message}"
-rescue CufinderRuby::CreditLimitError => e
+rescue Cufinder::CreditLimitError => e
   puts "Credit limit exceeded: #{e.message}"
-rescue CufinderRuby::ApiError => e
+rescue Cufinder::ApiError => e
   puts "API error #{e.status}: #{e.message}"
-rescue CufinderRuby::ValidationError => e
+rescue Cufinder::ValidationError => e
   puts "Validation error: #{e.message}"
 end
 ```
 
 ### Configuration
 
-You can configure the SDK with custom settings:
+You can configure the Client with custom settings:
 
 ```ruby
-sdk = CufinderRuby::SDK.new(
+sdk = Cufinder::Client.new(
   api_key: 'your-api-key',
-  base_url: 'https://api.cufinder.io/v2',  # Default
   timeout: 30,                              # Default
   max_retries: 3                           # Default
 )
-```
-
-## Development
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
-
-To install this gem onto your local machine, run `bundle exec rake install`.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/cufinder/cufinder-ruby.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```

data/cufinder-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "cufinder-ruby"
-  spec.version       = "0.0.1"
+  spec.version       = "1.0.0"
   spec.authors       = ["CUFinder Team"]
   spec.email         = ["support@cufinder.io"]
 

data/lib/cufinder_ruby/base_api_client.rb

@@ -0,0 +1,84 @@
+require "httparty"
+require "json"
+require "cufinder_ruby/errors"
+
+module Cufinder
+  class BaseApiClient
+    include HTTParty
+    
+    attr_reader :api_key, :base_url, :timeout, :max_retries
+    
+    def initialize(api_key:, timeout: 30, max_retries: 3)
+      @api_key = api_key
+      @base_url = "https://api.cufinder.io/v2"
+      @timeout = timeout
+      @max_retries = max_retries
+      
+      self.class.base_uri @base_url
+      self.class.headers "User-Agent" => "cufinder-ruby/#{Cufinder::VERSION}"
+    end
+    
+    def post(endpoint, data)
+      response = self.class.post(
+        endpoint,
+        body: form_encode(data),
+        headers: {
+          "x-api-key" => api_key,
+          "Content-Type" => "application/x-www-form-urlencoded"
+        },
+        timeout: @timeout
+      )
+      
+      handle_response(response)
+    end
+    
+    private
+    
+    def form_encode(data)
+      return "" if data.nil? || data.empty?
+      
+      data.map do |key, value|
+        next if value.nil?
+        
+        if value.is_a?(Array)
+          value.map { |v| "#{key}=#{CGI.escape(v.to_s)}" }.join("&")
+        else
+          "#{key}=#{CGI.escape(value.to_s)}"
+        end
+      end.compact.join("&")
+    end
+    
+    def handle_response(response)
+      case response.code
+      when 200..299
+        extract_data(response.parsed_response)
+      when 401
+        raise AuthenticationError, response.body
+      when 402
+        raise CreditLimitError, response.body
+      when 429
+        raise RateLimitError, response.body
+      else
+        raise ApiError.new(response.code, response.body)
+      end
+    rescue JSON::ParserError => e
+      raise HttpError, "Failed to parse response: #{e.message}"
+    rescue HTTParty::Error => e
+      raise HttpError, "HTTP request failed: #{e.message}"
+    end
+    
+    def extract_data(response_data)
+      # Extract data from wrapper if present (similar to Go SDK's mapToStruct)
+      if response_data.is_a?(Hash) && response_data.key?("data")
+        data = response_data["data"]
+        # Add meta_data if it exists in the outer response
+        if response_data.key?("meta_data")
+          data["meta_data"] = response_data["meta_data"]
+        end
+        data
+      else
+        response_data
+      end
+    end
+  end
+end

data/lib/cufinder_ruby/client.rb

@@ -1,84 +1,113 @@
-require "httparty"
-require "json"
-require "cufinder_ruby/errors"
+require "cufinder_ruby/base_api_client"
+require "cufinder_ruby/services"
 
-module CufinderRuby
+module Cufinder
+  # Main client class for interacting with the CUFinder API
+  # 
+  # This is the primary entry point for all API operations.
+  # It provides convenient methods for each service and handles
+  # authentication and HTTP communication internally.
+  #
+  # @example Basic usage
+  #   client = Cufinder::Client.new(api_key: 'your-api-key')
+  #   result = client.cuf(company_name: 'Example Corp', country_code: 'US')
+  #
   class Client
-    include HTTParty
-    
-    attr_reader :api_key, :base_url, :timeout, :max_retries
-    
-    def initialize(api_key:, base_url: "https://api.cufinder.io/v2", timeout: 30, max_retries: 3)
-      @api_key = api_key
-      @base_url = base_url
-      @timeout = timeout
-      @max_retries = max_retries
-      
-      self.class.base_uri base_url
-      self.class.timeout timeout
-      self.class.headers "User-Agent" => "cufinder-ruby/#{CufinderRuby::VERSION}"
-    end
-    
-    def post(endpoint, data)
-      response = self.class.post(
-        endpoint,
-        body: form_encode(data),
-        headers: {
-          "x-api-key" => api_key,
-          "Content-Type" => "application/x-www-form-urlencoded"
-        }
+    attr_reader :client, :services
+    
+    # Initialize a new CUFinder client
+    #
+    # @param api_key [String] Your CUFinder API key
+    # @param timeout [Integer] Request timeout in seconds (default: 30)
+    # @param max_retries [Integer] Maximum number of retries (default: 3)
+    def initialize(api_key:, timeout: 30, max_retries: 3)
+      @client = BaseApiClient.new(
+        api_key: api_key,
+        timeout: timeout,
+        max_retries: max_retries
       )
-      
-      handle_response(response)
-    end
-    
-    private
-    
-    def form_encode(data)
-      return "" if data.nil? || data.empty?
-      
-      data.map do |key, value|
-        next if value.nil?
-        
-        if value.is_a?(Array)
-          value.map { |v| "#{key}=#{CGI.escape(v.to_s)}" }.join("&")
-        else
-          "#{key}=#{CGI.escape(value.to_s)}"
-        end
-      end.compact.join("&")
-    end
-    
-    def handle_response(response)
-      case response.code
-      when 200..299
-        extract_data(response.parsed_response)
-      when 401
-        raise AuthenticationError, response.body
-      when 402
-        raise CreditLimitError, response.body
-      when 429
-        raise RateLimitError, response.body
-      else
-        raise ApiError.new(response.code, response.body)
-      end
-    rescue JSON::ParserError => e
-      raise HttpError, "Failed to parse response: #{e.message}"
-    rescue HTTParty::Error => e
-      raise HttpError, "HTTP request failed: #{e.message}"
-    end
-    
-    def extract_data(response_data)
-      # Extract data from wrapper if present (similar to Go SDK's mapToStruct)
-      if response_data.is_a?(Hash) && response_data.key?("data")
-        data = response_data["data"]
-        # Add meta_data if it exists in the outer response
-        if response_data.key?("meta_data")
-          data["meta_data"] = response_data["meta_data"]
-        end
-        data
-      else
-        response_data
-      end
+      @services = Services.new(@client)
+    end
+    
+    # Service methods - Each method corresponds to a CUFinder API service
+    def cuf(company_name:, country_code:)
+      @services.get_domain(company_name: company_name, country_code: country_code)
+    end
+    
+    def lcuf(company_name:)
+      @services.get_linkedin_url(company_name: company_name)
+    end
+    
+    def dtc(company_website:)
+      @services.get_company_name(company_website: company_website)
+    end
+    
+    def dte(company_website:)
+      @services.get_emails(company_website: company_website)
+    end
+    
+    def ntp(company_name:)
+      @services.get_phones(company_name: company_name)
+    end
+    
+    def rel(email:)
+      @services.get_person_by_email(email: email)
+    end
+    
+    def fcl(query:)
+      @services.find_company_lookalikes(query: query)
+    end
+    
+    def elf(query:)
+      @services.enrich_linkedin_fundraising(query: query)
+    end
+    
+    def car(query:)
+      @services.get_annual_revenue(query: query)
+    end
+    
+    def fcc(query:)
+      @services.find_company_children(query: query)
+    end
+    
+    def fts(query:)
+      @services.find_tech_stack(query: query)
+    end
+    
+    def epp(linkedin_url:)
+      @services.enrich_person_profile(linkedin_url: linkedin_url)
+    end
+    
+    def fwe(linkedin_url:)
+      @services.find_work_email(linkedin_url: linkedin_url)
+    end
+    
+    def tep(full_name:, company:)
+      @services.get_title_email_phone(full_name: full_name, company: company)
+    end
+    
+    def enc(query:)
+      @services.enrich_company(query: query)
+    end
+    
+    def cec(query:)
+      @services.get_company_employee_count(query: query)
+    end
+    
+    def clo(query:)
+      @services.get_company_locations(query: query)
+    end
+    
+    def cse(**params)
+      @services.search_companies(params)
+    end
+    
+    def pse(**params)
+      @services.search_people(params)
+    end
+    
+    def lbs(**params)
+      @services.search_local_businesses(params)
     end
   end
 end

data/lib/cufinder_ruby/errors.rb

@@ -1,4 +1,4 @@
-module CufinderRuby
+module Cufinder
   class Error < StandardError; end
   
   class AuthenticationError < Error; end

data/lib/cufinder_ruby/services.rb

@@ -1,8 +1,8 @@
-require "cufinder_ruby/client"
+require "cufinder_ruby/base_api_client"
 require "cufinder_ruby/types"
 require "cufinder_ruby/errors"
 
-module CufinderRuby
+module Cufinder
   class Services
     def initialize(client)
       @client = client

data/lib/cufinder_ruby/types.rb

@@ -1,4 +1,4 @@
-module CufinderRuby
+module Cufinder
   # Base response structure for all CUFinder API responses
   class BaseResponse
     attr_accessor :query, :credit_count, :meta_data, :confidence_level

data/lib/cufinder_ruby/version.rb

@@ -1,3 +1,3 @@
-module CufinderRuby
-  VERSION = "0.0.1"
+module Cufinder
+  VERSION = "1.0.0"
 end

data/lib/cufinder_ruby.rb

@@ -1,8 +1,8 @@
 require "cufinder_ruby/version"
+require "cufinder_ruby/base_api_client"
 require "cufinder_ruby/client"
-require "cufinder_ruby/sdk"
 require "cufinder_ruby/errors"
 
-module CufinderRuby
+module Cufinder
   class Error < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cufinder-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - CUFinder Team
@@ -95,9 +95,9 @@ files:
 - Rakefile
 - cufinder-ruby.gemspec
 - lib/cufinder_ruby.rb
+- lib/cufinder_ruby/base_api_client.rb
 - lib/cufinder_ruby/client.rb
 - lib/cufinder_ruby/errors.rb
-- lib/cufinder_ruby/sdk.rb
 - lib/cufinder_ruby/services.rb
 - lib/cufinder_ruby/types.rb
 - lib/cufinder_ruby/version.rb

data/lib/cufinder_ruby/sdk.rb

@@ -1,99 +0,0 @@
-require "cufinder_ruby/client"
-require "cufinder_ruby/services"
-
-module CufinderRuby
-  class SDK
-    attr_reader :client, :services
-    
-    def initialize(api_key:, base_url: "https://api.cufinder.io/v2", timeout: 30, max_retries: 3)
-      @client = Client.new(
-        api_key: api_key,
-        base_url: base_url,
-        timeout: timeout,
-        max_retries: max_retries
-      )
-      @services = Services.new(@client)
-    end
-    
-    # Convenience methods for each service
-    def cuf(company_name:, country_code:)
-      @services.get_domain(company_name: company_name, country_code: country_code)
-    end
-    
-    def lcuf(company_name:)
-      @services.get_linkedin_url(company_name: company_name)
-    end
-    
-    def dtc(company_website:)
-      @services.get_company_name(company_website: company_website)
-    end
-    
-    def dte(company_website:)
-      @services.get_emails(company_website: company_website)
-    end
-    
-    def ntp(company_name:)
-      @services.get_phones(company_name: company_name)
-    end
-    
-    def rel(email:)
-      @services.get_person_by_email(email: email)
-    end
-    
-    def fcl(query:)
-      @services.find_company_lookalikes(query: query)
-    end
-    
-    def elf(query:)
-      @services.enrich_linkedin_fundraising(query: query)
-    end
-    
-    def car(query:)
-      @services.get_annual_revenue(query: query)
-    end
-    
-    def fcc(query:)
-      @services.find_company_children(query: query)
-    end
-    
-    def fts(query:)
-      @services.find_tech_stack(query: query)
-    end
-    
-    def epp(linkedin_url:)
-      @services.enrich_person_profile(linkedin_url: linkedin_url)
-    end
-    
-    def fwe(linkedin_url:)
-      @services.find_work_email(linkedin_url: linkedin_url)
-    end
-    
-    def tep(full_name:, company:)
-      @services.get_title_email_phone(full_name: full_name, company: company)
-    end
-    
-    def enc(query:)
-      @services.enrich_company(query: query)
-    end
-    
-    def cec(query:)
-      @services.get_company_employee_count(query: query)
-    end
-    
-    def clo(query:)
-      @services.get_company_locations(query: query)
-    end
-    
-    def cse(**params)
-      @services.search_companies(params)
-    end
-    
-    def pse(**params)
-      @services.search_people(params)
-    end
-    
-    def lbs(**params)
-      @services.search_local_businesses(params)
-    end
-  end
-end