musicz 0.0.1

data/lib/musicz/search/options/artist_query_terms.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+
+module Musicz
+  module Search
+    module Options
+      # Setting any of these and passing into the repo terms query will
+      # include them in the query to the endpoint
+      class ArtistQueryTerms < Entity
+        attribute? :alias, Types::Strict::String.optional
+        attribute? :area, Types::Strict::String.optional
+        attribute? :artist, Types::Strict::String.optional
+        attribute? :artistaccent, Types::Strict::String.optional
+        attribute? :begin, Types::Strict::String.optional
+        attribute? :beginarea, Types::Strict::String.optional
+        attribute? :comment, Types::Strict::String.optional
+        attribute? :country, Types::Strict::String.optional
+        attribute? :end, Types::Strict::String.optional
+        attribute? :endarea, Types::Strict::String.optional
+        attribute? :gender, Types::Strict::String.optional
+        attribute? :ipi, Types::Strict::String.optional
+        attribute? :sortname, Types::Strict::String.optional
+        attribute? :tag, Types::Strict::String.optional
+        attribute? :type, Types::Strict::String.optional
+      end
+    end
+  end
+end

data/lib/musicz/search/options/id_search.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+
+module Musicz
+  module Search
+    module Options
+      class IdSearch < Entity
+        attribute :id, Types::Strict::String
+        attribute :relationships, Types::Array.of(Types::Strict::String)
+          .default([].freeze)
+      end
+    end
+  end
+end

data/lib/musicz/search/options/recording_query_terms.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+
+module Musicz
+  module Search
+    module Options
+      class RecordingQueryTerms < Entity
+        attribute? :artist, Types::Strict::String.optional
+        attribute? :title, Types::Strict::String.optional
+      end
+    end
+  end
+end

data/lib/musicz/search/recording_repository.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "musicz/entities/recording"
+require "musicz/entities/recording_list"
+require "musicz/search/repository"
+
+module Musicz
+  module Search
+    class RecordingRepository < Repository
+      ENDPOINT = "recording"
+
+      # @param id_options [Musicz::Search::Options::IdSearch]
+      def by_id(id_options)
+        by_id_with_entity(id_options, ENDPOINT, Musicz::Entities::Recording)
+      end
+
+      # @param term [String] The general term to searh MusicBrainz for
+      # This gets executed on the MusicBrainz server by querying
+      # the recording, sortname and alias fields
+      def by_term(term)
+        by_term_with_entity(term, ENDPOINT, Musicz::Entities::RecordingList)
+      end
+
+      # @param query_terms [Musicz::Search::Options::RecordingQueryTerms]
+      # This executes a generic query against the MusicBrainz API
+      # No support for paging, so use decently specific queries
+      def by_query(query_terms)
+        by_query_with_entity(
+          query_terms,
+          ENDPOINT,
+          Musicz::Entities::RecordingList
+        )
+      end
+    end
+  end
+end

data/lib/musicz/search/repository.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "json"
+require "musicz/entities/error"
+
+module Musicz
+  module Search
+    class Repository
+      def initialize(request: default_request)
+        @request = request
+      end
+
+      def by_id(_id_options)
+        raise NotImplementedError, "subclass must implement"
+      end
+
+      private
+
+      attr_reader :request
+
+      def default_request
+        Musicz::Request.build
+      end
+
+      def by_id_with_entity(id_options, endpoint, entity_class)
+        endpoint = "#{endpoint}/#{id_options.id}"
+        parameters = inc_params(id_options.relationships).merge(format_params)
+        response = request.get(endpoint: endpoint, parameters: parameters)
+        if response.success?
+          entity_class.new(JSON.parse(response.body))
+        else
+          build_error(response)
+        end
+      end
+
+      def by_term_with_entity(term, endpoint, entity_class)
+        query = {query: term}.merge(format_params)
+        response = request.get(endpoint: endpoint, parameters: query)
+        if response.success?
+          entity_class.new(JSON.parse(response.body))
+        else
+          build_error(response)
+        end
+      end
+
+      def by_query_with_entity(query_terms, endpoint, entity_class)
+        parameters = {query: build_query_param(query_terms)}
+          .merge(format_params)
+        response = request.get(endpoint: endpoint, parameters: parameters)
+        return build_error(response) unless response.success?
+
+        entity_class.new(JSON.parse(response.body))
+      end
+
+      def format_params
+        {
+          fmt: "json"
+        }
+      end
+
+      def inc_params(relations)
+        return {} if relations.empty?
+
+        {
+          inc: relations.join("+")
+        }
+      end
+
+      def build_query_param(query_terms)
+        valid_terms = query_terms.to_h.to_a.reject { |terms|
+          terms[0].to_s.empty?
+        }
+
+        query_items = valid_terms.map { |terms|
+          "#{terms[0]}:#{terms[1]}"
+        }
+        query_items.join(" AND ")
+      end
+
+      def build_error(response)
+        if response.code == 400 # JSON parseable
+          parsed = JSON.parse(response.body)
+          Musicz::Entities::Error.new(parsed)
+        else
+          Musicz::Entities::Error.new(
+            help: "Unknown error",
+            error: response.body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/musicz/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "dry-types"
+
+module Musicz
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/musicz/version.rb

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

data/musicz.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "musicz/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "musicz"
+  spec.version = Musicz::VERSION
+  spec.authors = ["Derrick Plotsky"]
+  spec.email = ["derrickplotsky@gmail.com"]
+
+  spec.summary = "Basic wrapper around musicbrainz"
+  spec.description = "A very basic wrapper around the nusicbrainz API"
+  spec.homepage = "https://github.com/derrickp/musicz"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/derrickp/musicz"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-struct", "~> 1.3"
+  spec.add_dependency "dry-types", "~> 1.4"
+  spec.add_dependency "typhoeus", "~> 1.4"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.13.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "standard", "~> 0.11"
+  spec.add_development_dependency "vcr", "~> 6.0"
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: musicz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derrick Plotsky
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A very basic wrapper around the nusicbrainz API
+email:
+- derrickplotsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/musicz.rb
+- lib/musicz/configuration.rb
+- lib/musicz/entities.rb
+- lib/musicz/entities/alias.rb
+- lib/musicz/entities/area.rb
+- lib/musicz/entities/area_reference.rb
+- lib/musicz/entities/area_relation.rb
+- lib/musicz/entities/artist.rb
+- lib/musicz/entities/artist_credit.rb
+- lib/musicz/entities/artist_list.rb
+- lib/musicz/entities/artist_reference.rb
+- lib/musicz/entities/disc_id.rb
+- lib/musicz/entities/error.rb
+- lib/musicz/entities/label_info_reference.rb
+- lib/musicz/entities/life_span.rb
+- lib/musicz/entities/media.rb
+- lib/musicz/entities/rating.rb
+- lib/musicz/entities/recording.rb
+- lib/musicz/entities/recording_list.rb
+- lib/musicz/entities/recording_reference.rb
+- lib/musicz/entities/release.rb
+- lib/musicz/entities/release_event.rb
+- lib/musicz/entities/release_group.rb
+- lib/musicz/entities/release_reference.rb
+- lib/musicz/entities/tag.rb
+- lib/musicz/entities/text_representation.rb
+- lib/musicz/entities/track.rb
+- lib/musicz/entity.rb
+- lib/musicz/request.rb
+- lib/musicz/search.rb
+- lib/musicz/search/area_repository.rb
+- lib/musicz/search/artist_repository.rb
+- lib/musicz/search/options/artist_query_terms.rb
+- lib/musicz/search/options/id_search.rb
+- lib/musicz/search/options/recording_query_terms.rb
+- lib/musicz/search/recording_repository.rb
+- lib/musicz/search/repository.rb
+- lib/musicz/types.rb
+- lib/musicz/version.rb
+- musicz.gemspec
+homepage: https://github.com/derrickp/musicz
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/derrickp/musicz
+  source_code_uri: https://github.com/derrickp/musicz
+post_install_message:
+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.1.4
+signing_key:
+specification_version: 4
+summary: Basic wrapper around musicbrainz
+test_files: []