lospec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dd31664ed14d707489f86eacf10037a7eb0875af1758100fcfea5673ed2ee9b
+  data.tar.gz: a669cffe86b57fdae1a883cebce8a80e36c2535f74a6a2d19692e3f012c9c450
+SHA512:
+  metadata.gz: 29657aed1c51c66c77a4d63da0acad77451d1e16c9e85be69919d86545b29ad6f5ceb67d9ec34631a80678e4a360339146b2ec3799f826c10a7f7e89f3e9092b
+  data.tar.gz: d93a79509fb015c567da995ff35e6b1fd6246e015bfb40cf0fcc7c98e30d8f5e7e9248c667604efdf5607f6ac0bc70a19d3e9933c0c4de33955cfed259f7413a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 John DeSilva
+
+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.

data/README.md

@@ -0,0 +1,63 @@
+# Lospec
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+Use `Lospec::Palette.search` to search for palettes. For example, to find a palette with four colors:
+```ruby
+palette = Lospec::Palette.search(colors: 4).first
+
+palette.slug   # => "tropical-fruit-04"
+palette.colors # => ["f5b413", "9c1904", "dd0956", "250442"]
+```
+
+You can also sort by most downloads first, and specify an endless range for colors. The available sort options are `%i[default alphabetical downloads newest]`.
+```ruby
+palette = Lospec::Palette.search(colors: ..3, tag: 'black', sort: :downloads).first
+
+palette.title  # => "1bit Monitor Glow"
+palette.colors # => ["222323", "f0f6f0"]
+```
+
+The search method returns a lazy enumerable, so you can filter and limit. For example, to find up to three popular palettes with four or more colors containing pure white:
+```ruby
+palettes = Lospec::Palette
+  .search(colors: 4.., sort: :downloads)
+  .filter { |palette| palette.colors.include?("ffffff") }
+  .take(3)
+  .to_a
+
+palettes.map(&:slug) # => ["2-bit-grayscale", "arq4", "cga-palette-1-high"]
+```
+
+If you know the slug of a specific palette, you can fetch it directly:
+```ruby
+palette = Lospec::Palette.fetch("nintendo-gameboy-bgb")
+
+palette.description # => "The default palette used by the bgb emulator..."
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Aesthetikx/lospec.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/Steepfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "json"
+  library "open-uri"
+end

data/lib/lospec/palette/search.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+require "open-uri/cached"
+
+module Lospec
+  class Palette
+    class Search
+      SORT_TYPES = %i[default alphabetical downloads newest].freeze
+
+      attr_reader :colors, :tag, :sort
+
+      def initialize(colors: nil, tag: "", sort: :default)
+        fail ArgumentError, "Sort should be one of #{SORT_TYPES}" unless SORT_TYPES.include?(sort.to_sym)
+
+        @colors = colors
+        @tag = tag
+        @sort = sort
+      end
+
+      def results(&)
+        return to_enum(:results).lazy unless block_given?
+
+        (0..).lazy.each do |page| # : Numeric
+          results = results_for_page(page:)
+
+          results.each(&)
+
+          break if results.empty?
+        end
+      end
+
+      private
+
+      def results_for_page(page:)
+        url = url(page:)
+
+        json = url.open.read
+
+        data = JSON.parse(json)
+
+        data["palettes"].map(&method(:parse))
+      end
+
+      def url(page: 0)
+        host = "lospec.com"
+
+        path = "/palette-list/load"
+
+        params = {
+          **colors_params,
+          page:,
+          tag:,
+          sortingType: sort
+        }
+
+        query = URI.encode_www_form params
+
+        URI::HTTPS.build(host:, path:, query:)
+      end
+
+      def colors_params # rubocop:disable Metrics
+        if colors.nil?
+          { colorNumberFilterType: "any" }
+        elsif colors.is_a?(Range) && colors.begin && colors.end
+          fail ArgumentError, "Range must be one sided"
+        elsif colors.is_a?(Range) && colors.begin.nil?
+          { colorNumberFilterType: "max", colorNumber: colors.end }
+        elsif colors.is_a?(Range) && colors.end.nil?
+          { colorNumberFilterType: "min", colorNumber: colors.begin }
+        elsif colors.is_a?(Numeric)
+          { colorNumberFilterType: "exact", colorNumber: colors }
+        else
+          fail ArgumentError, "Colors must be a number or one sided range"
+        end
+      end
+
+      def parse(json) # rubocop:disable Metrics
+        number = ->(n) { n.to_s.gsub(/[^0-9]/, "").to_i }
+
+        timestamp = Time.method(:parse)
+
+        Lospec::Palette.new(
+          id: json["_id"],
+          slug: json["slug"],
+          title: json["title"],
+          description: json["description"],
+          colors: json["colors"],
+          tags: json["tags"],
+          hashtag: json["hashtag"],
+          published_at: timestamp[json["publishedAt"]],
+          created_at: timestamp[json["createdAt"]],
+          downloads: number[json["downloads"]],
+          likes: number[json["likes"]],
+          comments: number[json["comments"]]
+        )
+      end
+    end
+  end
+end

data/lib/lospec/palette.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Lospec
+  class PaletteNotFound < Error
+    def initialize(slug)
+      super("Palette not found: #{slug}")
+    end
+  end
+
+  palette_attributes = %i[
+    id
+    slug
+    title
+    description
+    colors
+    tags
+    hashtag
+    published_at
+    created_at
+    downloads
+    likes
+    comments
+  ]
+
+  Palette = Data.define(*palette_attributes) do
+    def self.fetch(slug)
+      search = Lospec::Palette::Search.new(sort: :downloads)
+
+      result = search.results.detect { |palette| palette.slug == slug }
+
+      result or fail PaletteNotFound, slug
+    end
+
+    def self.search(...)
+      Lospec::Palette::Search.new(...).results
+    end
+  end
+end

data/lib/lospec/version.rb

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

data/lib/lospec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lospec
+  class Error < StandardError; end
+end
+
+require_relative "lospec/version"
+require_relative "lospec/palette"
+require_relative "lospec/palette/search"

data/lospec.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/lospec/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lospec"
+  spec.version = Lospec::VERSION
+  spec.authors = ["John DeSilva"]
+  spec.email = ["john@aesthetikx.info"]
+
+  spec.summary = "A simple gem to fetch palettes from Lospec.com"
+  spec.homepage = "https://github.com/Aesthetikx/lospec"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "open-uri-cached", "~> 1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/lospec.rbs

@@ -0,0 +1,64 @@
+module Lospec
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class PaletteNotFound < Error
+    def initialize: (String) -> void
+  end
+
+  class Palette
+    attr_reader id: String
+    attr_reader slug: String
+    attr_reader title: String
+    attr_reader description: String
+    attr_reader colors: Array[String]
+    attr_reader tags: Array[String]
+    attr_reader hashtag: String?
+    attr_reader published_at: Time
+    attr_reader created_at: Time
+    attr_reader downloads: Integer
+    attr_reader likes: Integer
+    attr_reader comments: Integer
+
+    def initialize: (
+      id: String,
+      slug: String,
+      title: String,
+      description: String,
+      colors: Array[String],
+      tags: Array[String],
+      hashtag: String?,
+      published_at: Time,
+      created_at: Time,
+      downloads: Integer,
+      likes: Integer,
+      comments: Integer,
+    ) -> void
+
+    class Search
+      SORT_TYPES: Array[Symbol]
+
+      attr_reader colors: (Numeric | Range[Numeric])?
+      attr_reader tag: String?
+      attr_reader sort: String | Symbol
+
+      def initialize: (
+        ?colors: Numeric | Range[Numeric],
+        ?tag: String,
+        ?sort: String | Symbol
+      ) -> void
+
+      def results: () -> Enumerator::Lazy[Palette, void]
+
+      private
+
+      def url: (page: Numeric) -> URI::HTTP
+
+      def colors_params: () -> Hash[Symbol, (String | Numeric)]
+
+      def results_for_page: (page: Numeric) -> Array[Palette]
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: lospec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeSilva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open-uri-cached
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- john@aesthetikx.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/lospec.rb
+- lib/lospec/palette.rb
+- lib/lospec/palette/search.rb
+- lib/lospec/version.rb
+- lospec.gemspec
+- sig/lospec.rbs
+homepage: https://github.com/Aesthetikx/lospec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Aesthetikx/lospec
+  source_code_uri: https://github.com/Aesthetikx/lospec
+  changelog_uri: https://github.com/Aesthetikx/lospec/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A simple gem to fetch palettes from Lospec.com
+test_files: []