berrycrawl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e72ddcb7e1f231189749c045fa62223de12c715a8f767c163e84d0856df40be
-  data.tar.gz: c5d667b602860e6fa52c360d019b177f037e0befb123bb4286390864ea5d7ebb
+  metadata.gz: ff033890f0609859b655c97db2e9995726eac6da14e8e67d5ad5db3a341bc5aa
+  data.tar.gz: 5c6b71e06970f5a72e0a44d26ebd89f87b1d972e95d9be7d29712f0869b0ca28
 SHA512:
-  metadata.gz: 0bbb2bf3a70a0a9fb447c080ee59dbbf36f5fffd17ca66ddf3ed69ddb9310c8455034692885901dc1df5daa0c42dd19491b7990dec1842f9f0d03f244377232f
-  data.tar.gz: d7ae3f5ea207dfba87d1cb532ef32a12edcfb8162db22688e738baf5db67b22e523baa1ccf2fce906c77488b8cf3028902c044964a8bd06f99be0e399c11c0fd
+  metadata.gz: 6000645f7d432db6f9939145e1ff77ecb16ae331cdab2c4e4c7effec89c7c3011185e172830edce71b73859a36194671cec9c7aa00139fd689045077ba87f09b
+  data.tar.gz: a2d4293cf44ee79e880e82e67a99443f39bfc9d2e43d5bd08ff0b2aca3c14869ad51b6775353611ae8465e63377271b576327fd57da0f5eaf770e9e609e4256e

data/.fern/metadata.json

@@ -5,8 +5,9 @@
   "generatorConfig": {
     "moduleName": "Berrycrawl"
   },
-  "originGitCommit": "a392c48ac4c6239a0801aa8866d9ad06f5f10496",
-  "originGitCommitIsDirty": true,
-  "invokedBy": "manual",
-  "requestedVersion": "0.1.0"
+  "originGitCommit": "70780c2043f50f399329b003aaf2dbac2584d072",
+  "originGitCommitIsDirty": false,
+  "invokedBy": "ci",
+  "requestedVersion": "0.2.0",
+  "ciProvider": "github"
 }

data/README.md

@@ -3,7 +3,7 @@
 
 The official Ruby SDK for scraping, crawling, searching, mapping, structured extraction, screenshots, and brand profiles.
 
-[Documentation](https://docs.berrycrawl.com) · [Dashboard](https://app.berrycrawl.com) · [GitHub](https://github.com/strawberry-labs/berrycrawl-ruby)
+[Documentation](https://docs.berrycrawl.com) · [Dashboard](https://berrycrawl.com/app) · [GitHub](https://github.com/strawberry-labs/berrycrawl-ruby)
 
 ## Table of Contents
 
@@ -24,7 +24,7 @@ A full reference for this library is available [here](./reference.md).
 
 ## Usage
 
-Set `BERRYCRAWL_API_KEY` to an API key from the [Berrycrawl dashboard](https://app.berrycrawl.com).
+Set `BERRYCRAWL_API_KEY` to an API key from the [Berrycrawl dashboard](https://berrycrawl.com/app).
 
 ```ruby
 require "berrycrawl"
@@ -49,6 +49,10 @@ brand = client.brand.retrieve(url: "https://stripe.com")
 puts brand.data
 ```
 
+### Brand design system
+
+Brand responses include an optional `branding` object for compatibility with older API deployments. When available, it contains the rendered light/dark scheme, semantic colors, typography, spacing, representative input and button styles, and semantic image roles. Use `branding.images.favicon` for the square icon and `branding.images.logo` for the wordmark.
+
 ## Environments
 
 This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.

data/lib/Berrycrawl/types/brand_component_style.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandComponentStyle < Internal::Types::Model
+      field :background, -> { String }, optional: true, nullable: false
+
+      field :border_color, -> { String }, optional: true, nullable: false, api_name: "borderColor"
+
+      field :border_radius, -> { String }, optional: true, nullable: false, api_name: "borderRadius"
+
+      field :shadow, -> { String }, optional: true, nullable: false
+
+      field :text_color, -> { String }, optional: true, nullable: false, api_name: "textColor"
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystem < Internal::Types::Model
+      field :colors, -> { Berrycrawl::Types::BrandDesignSystemColors }, optional: false, nullable: false
+
+      field :color_scheme, -> { Berrycrawl::Types::BrandDesignSystemColorScheme }, optional: false, nullable: false, api_name: "colorScheme"
+
+      field :components, -> { Berrycrawl::Types::BrandDesignSystemComponents }, optional: false, nullable: false
+
+      field :images, -> { Berrycrawl::Types::BrandDesignSystemImages }, optional: false, nullable: false
+
+      field :spacing, -> { Berrycrawl::Types::BrandDesignSystemSpacing }, optional: false, nullable: false
+
+      field :typography, -> { Berrycrawl::Types::BrandDesignSystemTypography }, optional: false, nullable: false
+    end
+  end
+end

data/lib/Berrycrawl/types/{search_response_provider.rb → brand_design_system_color_scheme.rb}

@@ -2,10 +2,11 @@
 
 module Berrycrawl
   module Types
-    module SearchResponseProvider
+    module BrandDesignSystemColorScheme
       extend Berrycrawl::Internal::Types::Enum
 
-      PARALLEL = "parallel"
+      LIGHT = "light"
+      DARK = "dark"
     end
   end
 end

data/lib/Berrycrawl/types/brand_design_system_colors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemColors < Internal::Types::Model
+      field :accent, -> { String }, optional: true, nullable: false
+
+      field :background, -> { String }, optional: true, nullable: false
+
+      field :link, -> { String }, optional: true, nullable: false
+
+      field :primary, -> { String }, optional: true, nullable: false
+
+      field :secondary, -> { String }, optional: true, nullable: false
+
+      field :text_primary, -> { String }, optional: true, nullable: false, api_name: "textPrimary"
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_components.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemComponents < Internal::Types::Model
+      field :button_primary, -> { Berrycrawl::Types::BrandComponentStyle }, optional: true, nullable: false, api_name: "buttonPrimary"
+
+      field :button_secondary, -> { Berrycrawl::Types::BrandComponentStyle }, optional: true, nullable: false, api_name: "buttonSecondary"
+
+      field :input, -> { Berrycrawl::Types::BrandComponentStyle }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_images.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemImages < Internal::Types::Model
+      field :favicon, -> { String }, optional: true, nullable: false
+
+      field :logo, -> { String }, optional: true, nullable: false
+
+      field :og_image, -> { String }, optional: true, nullable: false, api_name: "ogImage"
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_spacing.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemSpacing < Internal::Types::Model
+      field :base_unit, -> { Integer }, optional: false, nullable: false, api_name: "baseUnit"
+
+      field :border_radius, -> { String }, optional: true, nullable: false, api_name: "borderRadius"
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_typography.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemTypography < Internal::Types::Model
+      field :font_families, -> { Berrycrawl::Types::BrandDesignSystemTypographyFontFamilies }, optional: false, nullable: false, api_name: "fontFamilies"
+
+      field :font_sizes, -> { Berrycrawl::Types::BrandDesignSystemTypographyFontSizes }, optional: false, nullable: false, api_name: "fontSizes"
+
+      field :font_stacks, -> { Berrycrawl::Types::BrandDesignSystemTypographyFontStacks }, optional: false, nullable: false, api_name: "fontStacks"
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_typography_font_families.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemTypographyFontFamilies < Internal::Types::Model
+      field :heading, -> { String }, optional: true, nullable: false
+
+      field :primary, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_typography_font_sizes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemTypographyFontSizes < Internal::Types::Model
+      field :body, -> { String }, optional: true, nullable: false
+
+      field :h1, -> { String }, optional: true, nullable: false
+
+      field :h2, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_design_system_typography_font_stacks.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Berrycrawl
+  module Types
+    class BrandDesignSystemTypographyFontStacks < Internal::Types::Model
+      field :body, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :heading, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :paragraph, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/Berrycrawl/types/brand_profile.rb

@@ -3,6 +3,8 @@
 module Berrycrawl
   module Types
     class BrandProfile < Internal::Types::Model
+      field :branding, -> { Berrycrawl::Types::BrandDesignSystem }, optional: true, nullable: false
+
       field :colors, -> { Internal::Types::Array[Berrycrawl::Types::BrandProfileColorsItem] }, optional: false, nullable: false
 
       field :description, -> { String }, optional: true, nullable: false

data/lib/Berrycrawl/types/search_response.rb

@@ -7,8 +7,6 @@ module Berrycrawl
 
       field :data, -> { Internal::Types::Array[Berrycrawl::Types::SearchResult] }, optional: false, nullable: false
 
-      field :provider, -> { Berrycrawl::Types::SearchResponseProvider }, optional: false, nullable: false
-
       field :query, -> { String }, optional: false, nullable: false
 
       field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false

data/lib/Berrycrawl/types/search_result.rb

@@ -3,8 +3,6 @@
 module Berrycrawl
   module Types
     class SearchResult < Internal::Types::Model
-      field :provider, -> { Berrycrawl::Types::SearchResultProvider }, optional: true, nullable: false
-
       field :published_date, -> { String }, optional: true, nullable: false, api_name: "publishedDate"
 
       field :snippet, -> { String }, optional: false, nullable: false

data/lib/Berrycrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Berrycrawl
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/Berrycrawl.rb

@@ -66,6 +66,17 @@ require_relative "Berrycrawl/types/action_dto"
 require_relative "Berrycrawl/types/agent_config_dto_mode"
 require_relative "Berrycrawl/types/agent_config_dto"
 require_relative "Berrycrawl/types/brand_asset"
+require_relative "Berrycrawl/types/brand_component_style"
+require_relative "Berrycrawl/types/brand_design_system_colors"
+require_relative "Berrycrawl/types/brand_design_system_color_scheme"
+require_relative "Berrycrawl/types/brand_design_system_components"
+require_relative "Berrycrawl/types/brand_design_system_images"
+require_relative "Berrycrawl/types/brand_design_system_spacing"
+require_relative "Berrycrawl/types/brand_design_system_typography_font_families"
+require_relative "Berrycrawl/types/brand_design_system_typography_font_sizes"
+require_relative "Berrycrawl/types/brand_design_system_typography_font_stacks"
+require_relative "Berrycrawl/types/brand_design_system_typography"
+require_relative "Berrycrawl/types/brand_design_system"
 require_relative "Berrycrawl/types/brand_profile_colors_item"
 require_relative "Berrycrawl/types/brand_profile_fonts_item"
 require_relative "Berrycrawl/types/brand_profile_socials_item"
@@ -99,8 +110,6 @@ require_relative "Berrycrawl/types/screenshot_cookie_dto_same_site"
 require_relative "Berrycrawl/types/screenshot_cookie_dto"
 require_relative "Berrycrawl/types/screenshot_location_dto"
 require_relative "Berrycrawl/types/screenshot_viewport_dto"
-require_relative "Berrycrawl/types/search_response_provider"
-require_relative "Berrycrawl/types/search_result_provider"
 require_relative "Berrycrawl/types/search_result"
 require_relative "Berrycrawl/types/search_response"
 require_relative "Berrycrawl/types/test_webhook_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berrycrawl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Strawberry Labs LLC
@@ -77,6 +77,17 @@ files:
 - lib/Berrycrawl/types/agent_config_dto.rb
 - lib/Berrycrawl/types/agent_config_dto_mode.rb
 - lib/Berrycrawl/types/brand_asset.rb
+- lib/Berrycrawl/types/brand_component_style.rb
+- lib/Berrycrawl/types/brand_design_system.rb
+- lib/Berrycrawl/types/brand_design_system_color_scheme.rb
+- lib/Berrycrawl/types/brand_design_system_colors.rb
+- lib/Berrycrawl/types/brand_design_system_components.rb
+- lib/Berrycrawl/types/brand_design_system_images.rb
+- lib/Berrycrawl/types/brand_design_system_spacing.rb
+- lib/Berrycrawl/types/brand_design_system_typography.rb
+- lib/Berrycrawl/types/brand_design_system_typography_font_families.rb
+- lib/Berrycrawl/types/brand_design_system_typography_font_sizes.rb
+- lib/Berrycrawl/types/brand_design_system_typography_font_stacks.rb
 - lib/Berrycrawl/types/brand_profile.rb
 - lib/Berrycrawl/types/brand_profile_colors_item.rb
 - lib/Berrycrawl/types/brand_profile_fonts_item.rb
@@ -134,9 +145,7 @@ files:
 - lib/Berrycrawl/types/screenshot_viewport_dto.rb
 - lib/Berrycrawl/types/search_dto.rb
 - lib/Berrycrawl/types/search_response.rb
-- lib/Berrycrawl/types/search_response_provider.rb
 - lib/Berrycrawl/types/search_result.rb
-- lib/Berrycrawl/types/search_result_provider.rb
 - lib/Berrycrawl/types/summary_format_dto.rb
 - lib/Berrycrawl/types/summary_format_dto_type.rb
 - lib/Berrycrawl/types/test_webhook_response.rb

data/lib/Berrycrawl/types/search_result_provider.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Berrycrawl
-  module Types
-    module SearchResultProvider
-      extend Berrycrawl::Internal::Types::Enum
-
-      PARALLEL = "parallel"
-    end
-  end
-end