discogs-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf847793a00fb7bc5dadf93ec1fe35852b8268ea
+  data.tar.gz: 5cc3ed15d1ba578f8eaa25ad92c1cce123f57b42
+SHA512:
+  metadata.gz: d674de4cae3a1a553e4f46645b32ce3a196fdcdff11f425d1b2bfeed83b0c38b8f9cb7e660e04de79ed954246b129b6ba67dc750ea120774395168855e47ae68
+  data.tar.gz: a9969cfacbaf1834aab962c203e251c58b801db3b7338276cfa8717a50e855b442f6eb1c60bf88e474b054dc47d44454200faeb82630032fc4201101aa34c8a6

data/README.md

@@ -0,0 +1,86 @@
+# Discogs::Api
+
+[![Build Status](https://travis-ci.org/shkm/discogs-api.svg?branch=master)](https://travis-ci.org/shkm/discogs-api)
+[![codecov](https://codecov.io/gh/shkm/discogs-api/branch/master/graph/badge.svg)](https://codecov.io/gh/shkm/discogs-api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/07116b2d10b61e6c2726/maintainability)](https://codeclimate.com/github/shkm/discogs-api/maintainability)
+
+
+A simple wrapper around the [Discogs API](https://www.discogs.com/developers/).
+
+I'm only aiming to implement endpoints that I actually use at this time, which is a very small subset of what's available. See [Implemented Endpoints](#user-content-implemented-endpoints) and consider opening an issue or PR if you need more.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discogs-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install discogs-api
+
+## Usage
+
+```ruby
+# Set up a client with your auth token and user agent
+client = Discogs::Api::Client.new('my-auth-token', 'my-user-agent')
+
+# Search for an artist
+Discogs::Api::Search.artist(client, query: 'Electric Octopus')
+
+# Search for a master
+Discogs::Api::Search.master(client, query: 'This is our Culture')
+
+# Search for an release
+Discogs::Api::Search.release(client, query: 'This is our Culture')
+
+# Search for a label
+Discogs::Api::Search.label(client, query: 'Heavy Psych Sounds')
+
+# Get an artist by its ID
+Discogs::Api::Artist.get(client, 5272208)
+
+# Get an artist's releases
+Discogs::Api::Artist.releases(client, 5272208)
+```
+
+## Implemented Endpoints
+
+- [ ] OAuth
+  - [ ] GET [oauth/request_token](https://www.discogs.com/developers/#page:authentication)
+  - [ ] POST [oauth/access_token](https://www.discogs.com/developers/#page:authentication)
+  - [ ] GET [oauth/identify](https://www.discogs.com/developers/#page:authentication)
+- [ ] Releases
+  - [ ] GET [releases/:id](https://www.discogs.com/developers/#page:database,header:database-release)
+  - [ ] GET [releases/:id/rating](https://www.discogs.com/developers/#page:database,header:database-community-release-rating-get)
+  - [ ] GET [releases/:id/rating/:user](https://www.discogs.com/developers/#page:database,header:database-release-rating-by-user)
+  - [ ] PUT [releases/:id/rating/:user](https://www.discogs.com/developers/#page:database,header:database-release-rating-by-user-put)
+  - [ ] DELETE [releases/:id/rating/:user](https://www.discogs.com/developers/#page:database,header:database-release-rating-by-user-delete)
+- [ ] Masters
+  - [ ] GET [masters/:id](https://www.discogs.com/developers/#page:database,header:database-master-release-get)
+  - [ ] GET [masters/:id/versions](https://www.discogs.com/developers/#page:database,header:database-master-release-get)
+- [x] Artists
+  - [x] GET [artists/:id](https://www.discogs.com/developers/#page:database,header:database-artist-get)
+  - [x] GET [artists/:id/releases](https://www.discogs.com/developers/#page:database,header:database-artist-releases)
+- [ ] Labels
+  - [ ] GET [label/:id](https://www.discogs.com/developers/#page:database,header:database-artist-releases)
+  - [ ] GET [label/:id/releases](https://www.discogs.com/developers/#page:database,header:database-all-label-releases-get)
+- [x] Search
+  - [x] GET [database/search](https://www.discogs.com/developers/#page:database,header:database-search-get)
+
+There are more endpoints regarding the marketplace, user identity, user collection, user wantlists, and user lists. I have no intention at all of implementing those at the moment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shkm/discogs-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/discogs/api.rb

@@ -0,0 +1,11 @@
+require "discogs/api/version"
+
+module Discogs
+  module Api; end
+end
+
+require 'discogs/api/url'
+require 'discogs/api/response'
+require 'discogs/api/client'
+require 'discogs/api/search'
+require 'discogs/api/artists'

data/lib/discogs/api/artists.rb

@@ -0,0 +1,9 @@
+module Discogs::Api::Artists
+  def self.get(client, artist_id)
+    client.get Discogs::Api::Url.resolve('artists', artist_id)
+  end
+
+  def self.releases(client, artist_id)
+    client.get Discogs::Api::Url.resolve('artists', artist_id, 'releases')
+  end
+end

data/lib/discogs/api/client.rb

@@ -0,0 +1,12 @@
+require 'http'
+
+class Discogs::Api::Client
+  def initialize(auth_token, user_agent)
+    @client = HTTP.auth("Discogs token=#{auth_token}")
+              .headers(user_agent: user_agent)
+  end
+
+  def get(*args)
+    Discogs::Api::Response.new(@client.get(*args))
+  end
+end

data/lib/discogs/api/response.rb

@@ -0,0 +1,6 @@
+# Simple wrapper around a HTTP::Response to easily parse JSON
+class Discogs::Api::Response < SimpleDelegator
+  def to_h
+    JSON.parse(to_s, symbolize_names: true)
+  end
+end

data/lib/discogs/api/search.rb

@@ -0,0 +1,25 @@
+module Discogs::Api::Search
+  def self.artist(client, params = {})
+    execute(client, { type: :artist }.merge(params))
+  end
+
+  def self.release(client, params = {})
+    execute(client, { type: :release }.merge(params))
+  end
+
+  def self.master(client, params = {})
+    execute(client, { type: :master }.merge(params))
+  end
+
+  def self.label(client, params = {})
+    execute(client, { type: :label }.merge(params))
+  end
+
+  private_class_method def self.execute(client, params = {})
+    params[:q] = params.delete(:query) if params[:query]
+
+    url = Discogs::Api::Url.resolve('database', 'search').freeze
+
+    client.get(url, params: params)
+  end
+end

data/lib/discogs/api/url.rb

@@ -0,0 +1,7 @@
+module Discogs::Api::Url
+  DEFAULT_ENDPOINT = 'https://api.discogs.com'.freeze
+
+  def self.resolve(*segments)
+    [ENV.fetch('DISCOGS_ENDPOINT', DEFAULT_ENDPOINT), *segments].join('/')
+  end
+end

data/lib/discogs/api/version.rb

@@ -0,0 +1,5 @@
+module Discogs
+  module Api
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: discogs-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jamie@schembri.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/discogs/api.rb
+- lib/discogs/api/artists.rb
+- lib/discogs/api/client.rb
+- lib/discogs/api/response.rb
+- lib/discogs/api/search.rb
+- lib/discogs/api/url.rb
+- lib/discogs/api/version.rb
+homepage: https://github.com/shkm/discogs-api
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Discogs API client in Ruby
+test_files: []