serpnode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12698d52fe2af2a41c4edf43988f3c413a34ec355991c9f4a8f722db2b45704b
+  data.tar.gz: 2a010a75db1d835afb5ff07a34af26a9759bcac8341a26f9cf2c4f5d81f7b35a
+SHA512:
+  metadata.gz: cd9e45e517ba969a0e385c4b61079f9a2ffedb8abb94a0417e27155073aa5b54c860cb596df099e55141909c102f9c0922e5207b4b9dba5e5429f91d22b88c90
+  data.tar.gz: 725350e13ef8512287f62d724f1a40a384d4ac63c44fff404b94e3030e9ac5d59c9d71a84f27eb700157f62a63e9cc33510325de8477c252c459e75980c8b6eb

data/README.md

@@ -0,0 +1,25 @@
+# Serpnode Ruby SDK
+
+Ruby client for the Serpnode API. Supports header or query auth and implements `status`, `search`, `options`, and `locations`.
+
+ 
+
+## Install
+
+```bash
+gem build serpnode.gemspec
+gem install serpnode-0.1.0.gem
+```
+
+## Usage
+
+```ruby
+require "serpnode"
+
+client = Serpnode::Client.new(api_key: ENV["SERPNODE_API_KEY"]) # or use_header_auth: false
+
+puts client.status
+puts client.search(q: "site:example.com", engine: "google")
+puts client.options
+puts client.locations(q: "United States")
+```

data/lib/serpnode/client.rb

@@ -0,0 +1,134 @@
+require "net/http"
+require "json"
+require "uri"
+
+module Serpnode
+  class Error < StandardError; end
+
+  class HTTPError < Error
+    attr_reader :status, :body
+
+    def initialize(message, status:, body: nil)
+      super(message)
+      @status = status
+      @body = body
+    end
+  end
+
+  class Client
+    DEFAULT_OPEN_TIMEOUT = 5
+    DEFAULT_READ_TIMEOUT = 30
+    DEFAULT_BASE = "https://api.serpnode.com/v1"
+
+    attr_reader :api_key, :api_base, :use_header_auth, :open_timeout, :read_timeout, :user_agent
+
+    def initialize(api_key:, api_base: DEFAULT_BASE, use_header_auth: true, open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT, user_agent: nil)
+      @api_key = api_key
+      @api_base = api_base.sub(/\/$/, "")
+      @use_header_auth = use_header_auth
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @user_agent = user_agent || default_user_agent
+    end
+
+    def status
+      get("/status")
+    end
+
+    def search(params = {})
+      get("/search", params)
+    end
+
+    def options(params = {})
+      get("/options", params)
+    end
+
+    def locations(params = {})
+      get("/locations", params)
+    end
+
+    private
+
+    def get(path, params = {})
+      request(:get, path, params: params)
+    end
+
+    def request(method, path, params: {})
+      uri = build_uri(path, params)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = open_timeout
+      http.read_timeout = read_timeout
+
+      request = build_http_request(method, uri)
+      attach_authentication(request)
+      attach_headers(request)
+
+      response = http.request(request)
+      handle_response(response)
+    end
+
+    def build_uri(path, params)
+      path = "/#{path}" unless path.start_with?("/")
+      uri = URI.parse("#{api_base}#{path}")
+
+      normalized_params = params.dup
+      unless use_header_auth
+        normalized_params = { api_key: api_key }.merge(normalized_params || {})
+      end
+
+      if normalized_params && !normalized_params.empty?
+        query = URI.encode_www_form(normalized_params)
+        uri.query = [uri.query, query].compact.join("&")
+      end
+      uri
+    end
+
+    def build_http_request(method, uri)
+      case method
+      when :get
+        Net::HTTP::Get.new(uri)
+      else
+        raise ArgumentError, "Unsupported method: #{method}"
+      end
+    end
+
+    def attach_authentication(request)
+      if use_header_auth
+        request["apikey"] = api_key
+      end
+    end
+
+    def attach_headers(request)
+      request["Accept"] = "application/json"
+      request["User-Agent"] = user_agent
+    end
+
+    def handle_response(response)
+      status = response.code.to_i
+      body = response.body
+      if status >= 200 && status < 300
+        parse_json(body)
+      else
+        message = begin
+          parsed = parse_json(body)
+          parsed.is_a?(Hash) && (parsed["message"] || parsed["error"]) || body
+        rescue JSON::ParserError
+          body
+        end
+        raise HTTPError.new("HTTP #{status}: #{message}", status: status, body: body)
+      end
+    end
+
+    def parse_json(string)
+      return nil if string.nil? || string.strip.empty?
+      JSON.parse(string)
+    end
+
+    def default_user_agent
+      "serpnode-ruby/#{Version::STRING} (Ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})"
+    end
+  end
+end
+
+

data/lib/serpnode/version.rb

@@ -0,0 +1,7 @@
+module Serpnode
+  module Version
+    STRING = "0.1.0"
+  end
+end
+
+

data/lib/serpnode.rb

@@ -0,0 +1,7 @@
+require "serpnode/version"
+require "serpnode/client"
+
+module Serpnode
+end
+
+

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: serpnode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your Name
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Ruby client for the Serpnode API: status, search, options, locations.'
+email:
+- you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/serpnode.rb
+- lib/serpnode/client.rb
+- lib/serpnode/version.rb
+homepage: https://serpnode.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://serpnode.com/
+  source_code_uri: https://github.com/everapihq/serpnode-ruby
+  changelog_uri: https://github.com/everapihq/serpnode-ruby/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Serpnode API client
+test_files: []