musicz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6012913c5aa48d9616ed9c0c2a433b53f28778a40395eee7113b34e48cfb8bd
+  data.tar.gz: fa3d5f939da30dd8109d011275ab8c19c2d7a4346644d5513b4da58be4fdcc80
+SHA512:
+  metadata.gz: 249192a32a98cfbcaea70a498d31281de7c24061f8a6f00b66b44ccf28f6fcb9d55f6d5c29080f65a40f25da92eb96d7422828b2091212acc074aa454c835caa
+  data.tar.gz: fa78d7af683f686e2bb57b83dc8466aa057d2126e4a334169255d26cc1db1193d2458a51a6d44563c66d3f6e92a5f51e00da891ab4c1fe69bebe55117cfe0b76

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Specs
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at derrickplotsky@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in musicz.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Derrick Plotsky
+
+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,73 @@
+# Musicz
+![Specs](https://github.com/derrickp/musicz/workflows/Specs/badge.svg)
+
+This will be a basic wrapper around the musicbrainz search API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'musicz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install musicz
+
+## Usage
+
+Since it's still early stages, most things are not done, even the convenience methods.
+
+But basic usage
+
+```ruby
+require 'musicz'
+
+Musicz.configure do |config|
+  config.app_name = 'APP_NAME'
+  config.contact = 'CONTACT_INFO'
+end
+
+artist_repo = Musicz::Search::ArtistRepository.new
+
+# Search by ID
+id_options = Musicz::Search::Options::IdSearch.new(id: 'ID')
+artist = artist_repo.by_id(id_options)
+
+# Search by term
+term = 'SOME_BAND_NAME'
+artist_list = artist_repo.by_term(term)
+```
+
+Want to find an artist by term and then get some related information?
+
+```ruby
+artist_repo = Musicz::Search::ArtistRepository.new
+artist_list = artist_repo.by_term('A_BAND_NAME')
+artist = artist_list.artists.first # Or get the one with the highest score
+id_options = Musicz::Search::Options::IdSearch.new(id: artist.id, relationships: ['releases'])
+full_artist = artist_repo.by_id(id_options)
+```
+
+## 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 tags, 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/derrickp/musicz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Musicz project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/derrickp/musicz/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'musicz'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/musicz.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "musicz/version"
+require "musicz/configuration"
+require "musicz/request"
+require "musicz/entities"
+require "musicz/search"
+
+module Musicz
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/musicz/configuration.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Musicz
+  class Configuration
+    class NoConfigBlockGiven < RuntimeError; end
+
+    class InvalidConfiguration < RuntimeError; end
+
+    DEFAULT_BASE_URI = "https://musicbrainz.org/ws/2"
+    attr_accessor :base_uri, :app_name, :contact
+
+    def initialize(base_uri: DEFAULT_BASE_URI)
+      @base_uri = base_uri
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      [].tap do |arr|
+        arr << "No base_uri" if base_uri.nil?
+        arr << "No app_name" if app_name.nil?
+        arr << "No contact" if contact.nil?
+      end
+    end
+
+    def self.build_default
+      new.tap do |c|
+        c.app_name = "Musicz"
+        c.contact = "https://github.com/derrickp/musicz"
+      end
+    end
+  end
+
+  def self.clear
+    @config = nil
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.config=(value)
+    unless value.is_a?(Configuration)
+      raise ArgumentError, "value is not a Configuration object"
+    end
+
+    raise ArgumentError, "invalid Configuration value" unless value.valid?
+
+    @config = value
+  end
+
+  def self.configure
+    raise Configuration::NoConfigBlockGiven unless block_given?
+
+    yield @config ||= Configuration.new
+    return if @config.valid?
+
+    raise Configuration::InvalidConfiguration, @config.errors
+  end
+end

data/lib/musicz/entities.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "musicz/entities/alias"
+require "musicz/entities/area"
+require "musicz/entities/artist_credit"
+require "musicz/entities/artist_list"
+require "musicz/entities/artist_reference"
+require "musicz/entities/artist"
+require "musicz/entities/disc_id"
+require "musicz/entities/error"
+require "musicz/entities/life_span"
+require "musicz/entities/media"
+require "musicz/entities/rating"
+require "musicz/entities/recording_reference"
+require "musicz/entities/recording"
+require "musicz/entities/release_event"
+require "musicz/entities/release_reference"
+require "musicz/entities/release"
+require "musicz/entities/tag"
+require "musicz/entities/text_representation"
+require "musicz/entities/track"

data/lib/musicz/entities/alias.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+
+module Musicz
+  module Entities
+    class Alias < Entity
+      attribute :name, Types::Strict::String
+      attribute :sort_name, Types::Strict::String
+      attribute? :locale, Types::Strict::String.optional
+      attribute :primary, Types::Strict::Bool.default(false)
+    end
+  end
+end

data/lib/musicz/entities/area.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+require "musicz/entities/area_relation"
+
+module Musicz
+  module Entities
+    class Area < Entity
+      attribute :id, Types::Strict::String
+      attribute :name, Types::Strict::String
+      attribute :sort_name, Types::Strict::String
+      attribute? :relations, Types::Array.of(AreaRelation).default([].freeze)
+      attribute :iso_3166_1_codes, Types::Array.of(Types::Strict::String)
+        .default([].freeze)
+      attribute? :disambiguation, Types::Strict::String.optional
+    end
+  end
+end

data/lib/musicz/entities/area_reference.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+
+module Musicz
+  module Entities
+    class AreaReference < Entity
+      attribute :id, Types::Strict::String
+      attribute :name, Types::Strict::String
+      attribute :sort_name, Types::Strict::String
+      attribute? :disambiguation, Types::Strict::String.optional
+    end
+  end
+end

data/lib/musicz/entities/area_relation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+require "musicz/entities/area_reference"
+
+module Musicz
+  module Entities
+    class AreaRelation < Entity
+      attribute? :attribute_ids, Types::Strict::Hash.optional
+      attribute :direction, Types::Strict::String
+      attribute :type_id, Types::Strict::String
+      attribute :ended, Types::Strict::Bool.default(false)
+      attribute? :end, Types::Strict::String.optional
+      attribute :area, AreaReference
+    end
+  end
+end

data/lib/musicz/entities/artist.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "musicz/entity"
+require "musicz/entities/alias"
+require "musicz/entities/life_span"
+require "musicz/entities/rating"
+require "musicz/entities/tag"
+require "musicz/entities/release_reference"
+require "musicz/entities/area"
+
+module Musicz
+  module Entities
+    class Artist < Entity
+      attribute :id, Types::Strict::String
+      attribute :name, Types::Strict::String
+      attribute :sort_name, Types::Strict::String
+      attribute? :begin_area, Area.optional
+      attribute? :score, Types::Strict::Integer.optional
+      attribute? :country, Types::Strict::String.optional
+      attribute? :disambiguation, Types::Strict::String.optional
+      attribute? :type, Types::Strict::String.optional
+      attribute? :life_span, LifeSpan.optional
+      attribute :aliases, Types::Strict::Array.of(Alias).default([].freeze)
+      attribute :tags, Types::Strict::Array.of(Tag).default([].freeze)
+      attribute? :rating, Rating.optional
+      attribute? :releases, Types::Array.of(ReleaseReference).default([].freeze)
+    end
+  end
+end