musicbrainz 0.7.7 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7229772a6c7a6856ce99aac9911bb4730ca5ceddfc77609fde69fbdefa8b9ab2
+  data.tar.gz: 5a9cab7520265b089cbc380148c99fc8144e3debd34670e0c96f9437a6a24e8e
+SHA512:
+  metadata.gz: c28ed7913d03641380d8491db8820f8ea31e2b8bb2969950b838de09805df395cb48c5cc95c21a1d647f00a48ea88c7ffc2218e714b26dfcea892f5851720aac
+  data.tar.gz: 469d7cce11dcecadd2f1abd2a16f23266f295edf523f3d6757b1760bd297ef2e86efeb3b00cb2a3c38301d8c3a9cc9d55df04e0246b289083affde999cfca1a8

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+# Adopted from
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1.173.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -1,7 +1,7 @@
+.ruby-version
 coverage
 .bundle
 tmp
-Gemfile.lock
 .gem
-*.swp
 pkg/*
+/vendor

data/Gemfile

@@ -1,2 +1,13 @@
 source 'https://rubygems.org'
+
 gemspec
+
+group :test do
+  gem 'rspec'
+end
+
+group :development, :test do
+  gem 'rake', '~> 13.1.0'
+  gem 'pry'
+  gem 'awesome_print'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    musicbrainz (0.8.0)
+      faraday
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.9.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    method_source (1.0.0)
+    net-http (0.4.1)
+      uri
+    nokogiri (1.16.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.3)
+    rake (13.1.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    uri (0.13.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  awesome_print
+  musicbrainz!
+  pry
+  rake (~> 13.1.0)
+  rspec
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Gregory Eremin
+Copyright (c) 2024 Gregory Eremin
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,9 +1,4 @@
-## MusicBrainz Web Service wrapper [![Travis CI](https://secure.travis-ci.org/magnolia-fan/musicbrainz.png)](http://travis-ci.org/magnolia-fan/musicbrainz)
-
-### Ruby Version
-**IMPORTANT!**
-
-Ruby version 1.9+ required. No support for 1.8.7 anymore, if you still on 1.8 consider using gem [version 0.5.2](https://github.com/magnolia-fan/musicbrainz/tree/v0.5.2#musicbrainz-web-service-wrapper-) and bundle it like this:
+## MusicBrainz Web Service wrapper
 
 ```ruby
 gem 'musicbrainz', '0.5.2'
@@ -121,11 +116,10 @@ MusicBrainz::Release.find(id)
 }
 ```
 
-MusicBrainz::Track
+MusicBrainz::Track (depreciated, now called Recording)
 ```ruby
 # Class Methods
 MusicBrainz::Track.find(id)
-MusicBrainz::ReleaseGroup.search(artist_name, track_name)
 
 # Fields
 {
@@ -136,6 +130,23 @@ MusicBrainz::ReleaseGroup.search(artist_name, track_name)
 }
 ```
 
+MusicBrainz::Recording
+```ruby
+# Class Methods
+MusicBrainz::Recording.find(id)
+MusicBrainz::Recording.search(track_name, artist_name)
+
+# Fields
+{
+  :id     	=> Integer,
+  :mbid			=> Integer,
+  :title		=> String,
+  :artist		=> String,
+	:releases	=> String,
+	:score		=> Integer
+}
+```
+
 ### Testing
 ```
 bundle exec rspec
@@ -156,6 +167,6 @@ bundle exec irb -r musicbrainz
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-### Copyright
+### License
 
-Copyright (c) 2014 Gregory Eremin. See [LICENSE](https://raw.github.com/magnolia-fan/musicbrainz/master/LICENSE) for further details.
+[MIT](https://raw.github.com/localhots/musicbrainz/master/LICENSE)

data/lib/musicbrainz/bindings/artist.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module MusicBrainz
   module Bindings
     module Artist

data/lib/musicbrainz/bindings/artist_search.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module MusicBrainz
   module Bindings
     module ArtistSearch

data/lib/musicbrainz/bindings/discid_releases.rb

@@ -0,0 +1,13 @@
+module MusicBrainz
+  module Bindings
+    module DiscidReleases
+      def parse(xml)
+        xml.xpath('./disc/release-list/release').map do |xml|
+          MusicBrainz::Bindings::Release.parse(xml)
+        end
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/recording.rb

@@ -0,0 +1,19 @@
+module MusicBrainz
+  module Bindings
+    module Recording
+      def parse(xml)
+        xml = xml.xpath('./recording') unless xml.xpath('./recording').empty?
+        {
+          id: (xml.attribute('id').value rescue nil),
+          mbid: (xml.attribute('id').value rescue nil), # Old shit
+          title: (xml.xpath('./title').text.gsub(/[`’]/, "'") rescue nil),
+          artist: (xml.xpath('./artist-credit/name-credit/artist/name').text rescue nil),
+          releases: (xml.xpath('./release-list/release/title').map{ |xml| xml.text } rescue []),
+          score: (xml.attribute('score').value.to_i rescue nil)
+        }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/{track_search.rb → recording_search.rb}

@@ -1,7 +1,6 @@
-# encoding: UTF-8
 module MusicBrainz
   module Bindings
-    module TrackSearch
+    module RecordingSearch 
       def parse(xml)
         xml.xpath('./recording-list/recording').map do |xml|
           {

data/lib/musicbrainz/bindings/relations.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module MusicBrainz
   module Bindings
     module Relations
@@ -23,4 +22,4 @@ module MusicBrainz
       extend self
     end
   end
-end
+end

data/lib/musicbrainz/bindings/release_group_search.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module MusicBrainz
   module Bindings
     module ReleaseGroupSearch

data/lib/musicbrainz/client_modules/caching_proxy.rb

@@ -19,28 +19,42 @@ module MusicBrainz
         response = { body: nil, status: 500 }
 
         if File.exist?(file_path)
-          response = {
-            body: File.open(file_path, 'rb').gets,
-            status: 200
-          }
+          get_cached_contents(file_path)
         else
-          response = super
+          response = get_live_contents(file_path, url)
           if response[:status] == 200
-            FileUtils.mkpath(dir_path)
-            File.open(file_path, 'wb') do |f|
-              f.puts(response[:body])
-              f.chmod(0755)
-              f.close
-            end
+            cache_contents!(file_path, response[:body])
           end
+          response
         end
-
-        response
       end
 
       def caching?
         MusicBrainz.config.perform_caching
       end
+
+    private
+
+      def get_cached_contents(file_path)
+        {
+          body: File.open(file_path, 'rb').gets,
+          status: 200
+        }
+      end
+
+      def get_live_contents(file_path, url)
+        http.get(url)
+      end
+
+      def cache_contents!(file_path, body)
+        dir_path = File.dirname(file_path)
+        FileUtils.mkpath(dir_path)
+        File.open(file_path, 'wb') do |f|
+          f.puts(body)
+          f.chmod(0755)
+          f.close
+        end
+      end
     end
   end
 end

data/lib/musicbrainz/models/base_model.rb

@@ -24,11 +24,16 @@ module MusicBrainz
         MusicBrainz.client
       end
 
+			def find(hash)
+				underscored_name = underscore_name.to_sym
+				client.load(underscored_name, hash, { binding: underscored_name, create_model: underscored_name })
+			end
+
 			def search(hash)
 				hash = escape_strings(hash)
 				query_val = build_query(hash)
-				underscore_name = self.name[13..-1].underscore
-				client.load(underscore_name.to_sym, { query: query_val, limit: 10 }, { binding: underscore_name.insert(-1,"_search").to_sym })
+				underscored_name = underscore_name
+				client.load(underscored_name.to_sym, { query: query_val, limit: 10 }, { binding: underscored_name.insert(-1,"_search").to_sym })
 			end
 
 			class ::String
@@ -53,6 +58,11 @@ module MusicBrainz
 				hash
 			end
 
+			def underscore_name
+				# self.name[13..-1] => removes MusicBrainz::
+				self.name[13..-1].underscore
+			end
+
 			# these probably should be private... but I'm not sure how to get it to work in a module...
 			# private_class_method :build_query, :escape_strings
     end

data/lib/musicbrainz/models/recording.rb

@@ -0,0 +1,20 @@
+module MusicBrainz
+  class Recording < BaseModel
+    field :id, String
+    field :mbid, String
+    field :title, String
+    field :artist, String
+		field :releases, String
+		field :score, Integer
+
+    class << self
+      def find(id)
+				super({ id: id })
+      end
+
+			def search(track_name, artist_name)
+				super({recording: track_name, artist: artist_name})
+			end
+    end
+  end
+end

data/lib/musicbrainz/models/release.rb

@@ -10,7 +10,7 @@ module MusicBrainz
     field :asin, String
     field :barcode, String
     field :quality, String
-    
+
     def tracks
       @tracks ||= client.load(:release, { id: id, inc: [:recordings, :media], limit: 100 }, {
         binding: :release_tracks,
@@ -26,6 +26,13 @@ module MusicBrainz
           create_model: :release
         })
       end
+
+      def find_by_discid(id)
+        client.load(:discid, { id: id }, {
+          binding: :discid_releases,
+          create_models: :release
+        })
+      end
     end
   end
 end

data/lib/musicbrainz/models/track.rb

@@ -12,10 +12,6 @@ module MusicBrainz
           create_model: :track
         })
       end
-
-			def search(artist_name, track_name)
-				super({artist: artist_name, recording: track_name})
-			end
     end
   end
 end

data/lib/musicbrainz/version.rb

@@ -1,3 +1,3 @@
 module MusicBrainz
-  VERSION = "0.7.7"
+  VERSION = "0.8.0"
 end

data/lib/musicbrainz.rb

@@ -20,10 +20,12 @@ require "musicbrainz/models/artist"
 require "musicbrainz/models/release_group"
 require "musicbrainz/models/release"
 require "musicbrainz/models/track"
+require "musicbrainz/models/recording"
 
 require "musicbrainz/bindings/artist"
 require "musicbrainz/bindings/artist_search"
 require "musicbrainz/bindings/artist_release_groups"
+require "musicbrainz/bindings/discid_releases"
 require "musicbrainz/bindings/relations"
 require "musicbrainz/bindings/release_group"
 require "musicbrainz/bindings/release_group_search"
@@ -31,7 +33,8 @@ require "musicbrainz/bindings/release_group_releases"
 require "musicbrainz/bindings/release"
 require "musicbrainz/bindings/release_tracks"
 require "musicbrainz/bindings/track"
-require "musicbrainz/bindings/track_search"
+require "musicbrainz/bindings/recording"
+require "musicbrainz/bindings/recording_search"
 
 module MusicBrainz
   GH_PAGE_URL = "http://git.io/brainz"

data/musicbrainz.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Gregory Eremin"]
   gem.email         = ["magnolia_fan@me.com"]
   gem.summary       = %q{ MusicBrainz Web Service wrapper with ActiveRecord-style models }
-  gem.homepage      = "http://github.com/magnolia-fan/musicbrainz"
+  gem.homepage      = "http://github.com/localhots/musicbrainz"
 
   gem.files         = %x{ git ls-files }.split($\)
   gem.executables   = []
@@ -14,9 +14,6 @@ Gem::Specification.new do |gem|
   gem.version       = MusicBrainz::VERSION
   gem.license       = "MIT"
 
-  gem.add_dependency('faraday')
-  gem.add_dependency('nokogiri')
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('awesome_print')
-  gem.add_development_dependency('rake', '~> 10.4.0')
+  gem.add_runtime_dependency('faraday')
+  gem.add_runtime_dependency('nokogiri')
 end

data/spec/bindings/recording_search_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe MusicBrainz::Bindings::RecordingSearch do
+  describe '.parse' do
+    let(:response) {
+      <<-XML
+        <metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#" xmlns:ext="http://musicbrainz.org/ns/ext#-2.0">
+          <recording-list count="1" offset="0">
+            <recording ext:score="100" id="0b382a13-32f0-4743-9248-ba5536a6115e">
+              <title>King Fred</title>
+              <artist-credit>
+                <name-credit>
+                  <artist id="f52f7a92-d495-4d32-89e7-8b1e5b8541c8">
+                    <name>Too Much Joy</name>
+                  </artist>
+                </name-credit>
+              </artist-credit>
+              <release-list>
+                <release id="8442e42b-c40a-4817-89a0-dbe663c94d2d">
+                  <title>Green Eggs and Crack</title>
+                </release>
+              </release-list>
+            </recording>
+          </recording-list>
+        </metadata>
+      XML
+    }
+    let(:xml) {
+      Nokogiri::XML.parse(response).remove_namespaces!
+    }
+    let(:metadata) {
+      described_class.parse(xml.xpath('/metadata'))
+    }
+
+    it "gets correct Recording data" do
+      expect(metadata).to eq [
+        {
+          id: '0b382a13-32f0-4743-9248-ba5536a6115e',
+          mbid: '0b382a13-32f0-4743-9248-ba5536a6115e',
+          title: 'King Fred',
+          artist: 'Too Much Joy',
+          releases: ['Green Eggs and Crack'],
+          score: 100,
+        }
+      ]
+    end
+  end
+end

data/spec/bindings/relations_spec.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require "spec_helper"
 
 describe MusicBrainz::Bindings::Relations do
@@ -7,38 +5,59 @@ describe MusicBrainz::Bindings::Relations do
     describe 'attributes' do
       describe 'urls' do
         context '1 url for relation type' do
+          let(:response) {
+            <<-XML
+              <artist>
+                <relation-list target-type="url">
+                  <relation type="social network" type-id="99429741-f3f6-484b-84f8-23af51991770">
+                    <target id="4f4068cb-7001-47a3-a2fe-9146eb6b5d16">https://plus.google.com/+Madonna</target>
+                  </relation>
+                </relation-list>
+              </artist>
+            XML
+          }
+          let(:xml) {
+            Nokogiri::XML.parse(response)
+          }
+          let(:artist) {
+            described_class.parse(xml.xpath('./artist'))
+          }
+
           it 'returns a string' do
-            xml = Nokogiri::XML.parse(
-              %Q{<artist><relation-list target-type="url">
-                <relation type-id="99429741-f3f6-484b-84f8-23af51991770" type="social network">
-                  <target id="4f4068cb-7001-47a3-a2fe-9146eb6b5d16">https://plus.google.com/+Madonna</target>
-                </relation>
-              </relation-list></artist>}
-            )
-            
-            described_class.parse(xml.xpath('./artist'))[:urls][:social_network].should == 'https://plus.google.com/+Madonna'
+            expect(artist[:urls][:social_network]).to eq 'https://plus.google.com/+Madonna'
           end
         end
-        
+
         context 'multiple urls for relation types' do
-          it 'returns an array' do
-            xml = Nokogiri::XML.parse(
-              %Q{<artist><relation-list target-type="url">
-                <relation type-id="99429741-f3f6-484b-84f8-23af51991770" type="social network">
-                  <target id="4f4068cb-7001-47a3-a2fe-9146eb6b5d16">https://plus.google.com/+Madonna</target>
-                </relation>
-                <relation type-id="99429741-f3f6-484b-84f8-23af51991770" type="social network">
-                  <target id="1dc9e14d-ebfb-448c-a005-e3481d320595">https://www.facebook.com/madonna</target>
-                </relation>
-              </relation-list></artist>}
-            )
+          let(:response) {
+            <<-XML
+              <artist>
+                <relation-list target-type="url">
+                  <relation type="social network" type-id="99429741-f3f6-484b-84f8-23af51991770">
+                    <target id="4f4068cb-7001-47a3-a2fe-9146eb6b5d16">https://plus.google.com/+Madonna</target>
+                  </relation>
+                  <relation type="social network" type-id="99429741-f3f6-484b-84f8-23af51991770">
+                    <target id="1dc9e14d-ebfb-448c-a005-e3481d320595">https://www.facebook.com/madonna</target>
+                  </relation>
+                </relation-list>
+              </artist>
+            XML
+          }
+          let(:xml) {
+            Nokogiri::XML.parse(response)
+          }
+          let(:artist) {
+            described_class.parse(xml.xpath('./artist'))
+          }
 
-            described_class.parse(xml.xpath('./artist'))[:urls][:social_network].should == [
-              'https://plus.google.com/+Madonna', 'https://www.facebook.com/madonna'
+          it 'returns an array' do
+            expect(artist[:urls][:social_network]).to eq [
+              'https://plus.google.com/+Madonna',
+              'https://www.facebook.com/madonna',
             ]
           end
         end
       end
     end
   end
-end
+end

data/spec/bindings/release_group_search_spec.rb

@@ -1,15 +1,33 @@
-# -*- encoding: utf-8 -*-
-
 require "spec_helper"
 
 describe MusicBrainz::Bindings::ReleaseGroupSearch do
   describe '.parse' do
+    let(:response) {
+      <<-XML
+        <metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#" xmlns:ext="http://musicbrainz.org/ns/ext#-2.0">
+          <release-group-list>
+            <release-group ext:score="100" id="246bc928-2dc8-35ba-80ee-7a0079de1632" type="Single">
+              <title>Empire</title>
+            </release-group>
+          </release-group-list>
+        </metadata>
+      XML
+    }
+    let(:xml) {
+      Nokogiri::XML.parse(response)
+    }
+    let(:metadata) {
+      described_class.parse(xml.remove_namespaces!.xpath('/metadata'))
+    }
+
     it "gets correct release group data" do
-      response = '<metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#" xmlns:ext="http://musicbrainz.org/ns/ext#-2.0"><release-group-list><release-group id="246bc928-2dc8-35ba-80ee-7a0079de1632" type="Single" ext:score="100"><title>Empire</title></release-group></release-group-list></metadata>'
-      described_class.parse(Nokogiri::XML.parse(response).remove_namespaces!.xpath('/metadata')).should == [
+      expect(metadata).to eq [
         {
-          id: '246bc928-2dc8-35ba-80ee-7a0079de1632', mbid: '246bc928-2dc8-35ba-80ee-7a0079de1632', 
-          title: 'Empire', type: 'Single', score: 100
+          id: '246bc928-2dc8-35ba-80ee-7a0079de1632',
+          mbid: '246bc928-2dc8-35ba-80ee-7a0079de1632',
+          title: 'Empire',
+          type: 'Single',
+          score: 100,
         }
       ]
     end