trailer_vote-api 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c36cbd2a3291e9d71f60f52856c3b2ccfbd39953
-  data.tar.gz: 454952b01ccb6acc926b4955da0069190462e836
+  metadata.gz: dd4ad9b6f52cdb85e1ccfda2c56f47483326b7af
+  data.tar.gz: 9647720f9c87abf3e54cc0e8c1682f1fec0b3eff
 SHA512:
-  metadata.gz: 317ba976bffc5a1ff85254ea1babf3ec72517f83893ad76b23d32dc452bbb07cd373a40ae54937f41807113339fef487fb9cae9314f695649c662a8845924a19
-  data.tar.gz: a44bce3cf05ecf0492c547503b0ad732559940040efc35ff783fc27da31ebccf7379810b1b2a6a270f395c7d56e2f0eb59a6f9fc651acb5682e0c8643dba8a6f
+  metadata.gz: ca335c29541ad3333016bdf76abfaee34a73819599e5ff825c55ef04cbeac59b66add6e3efed6300fa2c768fdbc6a8f9be81f88262375cf38b7320d26e625d30
+  data.tar.gz: 9e3fa02068a7d4e94c3d40e11d64f6d9b05052fc26bdacd9d362292ba30c2388133805baea0ac89db4a7a68d93a87518ea37adf524d5192e4d21a1ee1261a174

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.8.3
+
+- Add `Issue` media create API
+
 # 0.8.2
 
 - Add a fallback if the `errors` is decoded correctly, but not the correct format.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trailer_vote-api (0.8.2)
+    trailer_vote-api (0.8.3)
       http (>= 3.3.0, < 4.x)
       oj (>= 3.6, < 4.x)
       trailer_vote-media_types (>= 0.6.1, < 1)
@@ -39,7 +39,7 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    oj (3.6.11)
+    oj (3.6.12)
     public_suffix (3.0.3)
     rake (10.5.0)
     ruby-progressbar (1.10.0)
@@ -49,10 +49,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    trailer_vote-media_types (0.6.3)
+    trailer_vote-media_types (0.8.0)
       media_types (>= 0.6.0, < 1)
     unf (0.1.4)
       unf_ext
+    unf_ext (0.0.7.5)
     unf_ext (0.0.7.5-x64-mingw32)
     webmock (3.4.2)
       addressable (>= 2.3.6)
@@ -60,6 +61,7 @@ GEM
       hashdiff
 
 PLATFORMS
+  ruby
   x64-mingw32
 
 DEPENDENCIES

data/README.md

@@ -2,9 +2,10 @@
 [![Build Status](https://travis-ci.com/TrailerVote/trailervote-api-clients.svg?branch=master)](https://travis-ci.com/TrailerVote/trailervote-api-clients)
 [![Gem Version](https://badge.fury.io/rb/trailer_vote-api.svg)](https://badge.fury.io/rb/trailer_vote-api)
 [![Maintainability](https://api.codeclimate.com/v1/badges/da722ca43c5811db5926/maintainability)](https://codeclimate.com/github/TrailerVote/trailervote-api-clients/maintainability)
+[![Depfu](https://badges.depfu.com/badges/abcb16e9c6a98f7ce7ce9f8379f8b2c7/overview.svg)](https://depfu.com/github/TrailerVote/trailervote-api-clients?project_id=5890)
 
 The TrailerVote Api gem is the official interface to communicate with the TrailerVote product service. It allows you to
-keep your code simple and not deal with the HTTP suite. 
+keep your code simple and not deal with the HTTP suite.
 
 ## Installation
 
@@ -36,7 +37,7 @@ configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
 # => TrailerVote::Api::Configuration
 ```
 
-The TrailerVote API Client for Ruby uses a lazy chainable API and does **NOT** make any requests until it's absolutely necessary. 
+The TrailerVote API Client for Ruby uses a lazy chainable API and does **NOT** make any requests until it's absolutely necessary.
 It is recommended that you re-use the configuration instance, as well as other results, in order to reduce network requests.
 
 The common interface is:
@@ -52,7 +53,7 @@ Unless data is being posted, `#call` is not necessary:
 ```Ruby
 configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
 configuration.links
-# => TrailerVote::Api::Links # Makes the HTTP call if necessary 
+# => TrailerVote::Api::Links # Makes the HTTP call if necessary
 ```
 
 In case of an error, a `TrailerVote::Api::Error` is raised, with subclasses defining what went wrong. If the API gives back an error (HTTP status `(400..599)`), the error is parsed and turned into a `ErrorsResponse < Error` error.
@@ -81,9 +82,9 @@ require 'trailer_vote/api/product/lookup'
 
 lookup = configuration.product.lookup
 # => TrailerVote::Api::Product::Lookup
- 
+
 lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }, { authority: 'tmdb', identifier: '12345678' }])
-# => TrailerVote::Api::Product::Find 
+# => TrailerVote::Api::Product::Find
 ```
 
 ### `configuration.product.update`
@@ -98,7 +99,7 @@ require 'trailer_vote/api/product/update'
 lookup = configuration.product.lookup
 product = lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
 # => TrailerVote::Api::Product::Find
- 
+
 current_product_data = product.data
 next_product_data = make_changes_to_product_data(current_product_data)
 product.update.call(data: next_product_data)
@@ -109,7 +110,7 @@ If the update call fails with a `409 Conflict` or `412 Precondition Failed`, it
 
 ### `configuration.product.create`
 Creating a product is similar to looking up a product. If successful, returns an actual `Product::Find`.
- 
+
 The `data` argument is wrapped in `{ product: data }` and then needs to match `application/vnd.trailervote.product.v2.create+json`
 
 ```Ruby
@@ -123,7 +124,7 @@ configuration.product.create(data: { title: 'My product', ... })
 To attach an video to a product, you first need to find the product. This can be done by:
  - `configuration.product.create`: creating a new product
  - `configuration.product.lookup`: looking up an existing product
- 
+
 Once you have it, the video operations are available on the result.
 
 The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
@@ -134,7 +135,7 @@ require 'trailer_vote/api/product/video/create'
 
 product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
 # => TrailerVote::Api::Product::Find
- 
+
 product.video.create(data: { source_url: '', ... })
 # => TrailerVote::Api::Product::Video::Find
 ```
@@ -148,7 +149,7 @@ Gets all the image urls for a product
 To attach an video to a product, you first need to find the product. This can be done by:
  - `configuration.product.create`: creating a new product
  - `configuration.product.lookup`: looking up an existing product
- 
+
 Once you have it, the video operations are available on the result.
 
 The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
@@ -159,7 +160,7 @@ require 'trailer_vote/api/product/video/create'
 
 product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
 # => TrailerVote::Api::Product::Find
- 
+
 product.video.create(data: { source_url: '', ... })
 # => TrailerVote::Api::Product::Video::Find
 ```
@@ -179,7 +180,7 @@ also run `bin/console` for an interactive prompt that will allow you to experime
 
 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 update trailer_vote-api` in any repository that depends on
-this gem. If you have push rights, you may call `bundle exec rake release` to create a new git tag, push 
+this gem. If you have push rights, you may call `bundle exec rake release` to create a new git tag, push
 git commits and tags, and push the `.gem` file to the rubygems gem server.
 
 ## Contributing

data/lib/trailer_vote/api/autoload.rb

@@ -2,6 +2,9 @@
 
 require 'trailer_vote/api'
 
+require 'trailer_vote/api/issue'
+require 'trailer_vote/api/issue/create'
+require 'trailer_vote/api/issue/find'
 require 'trailer_vote/api/place'
 require 'trailer_vote/api/place/create'
 require 'trailer_vote/api/place/find'

data/lib/trailer_vote/api/issue/create.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+require 'trailer_vote/api/issue'
+require 'trailer_vote/api/issue/find'
+
+module TrailerVote
+  module Api
+    class Issue
+
+      def create
+        Create.new(configuration: configuration)
+      end
+
+      class Create
+        include Composable::Common
+
+        CONTENT = MediaTypes::Issue.to_constructable.version(1).view('create')
+        SUCCESS = MediaTypes::Issue.to_constructable.version(1)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        # @private
+        def initialize(configuration:)
+          self.configuration = configuration
+        end
+
+        def back
+          configuration.issue
+        end
+
+        # Create an issue
+        #
+        # @see https://www.rubydoc.info/gems/trailer_vote-media_types/TrailerVote/MediaTypes/Issue TrailerVote::MediaTypes::Issue
+        #
+        # @param [String, Hash] data the data conform to the Issue media type
+        # @param [String] url (#resolve_url result) the url to post to
+        #
+        # @return [TrailerVote::Api::Issue]
+        def call(data:, url: resolve_url)
+          guard_network_errors do
+            body = encode(data)
+            branch(
+              resolve_client.headers(
+                Headers::ACCEPT => ACCEPT,
+                Headers::CONTENT_TYPE => "#{CONTENT}; charset=#{body.encoding.name}"
+              ).post(url, body: body),
+              data: data
+            )
+          end
+        end
+
+        private
+
+        attr_accessor :configuration
+
+        def resolve_url
+          configuration.links.issues
+        end
+
+        def encode(data)
+          TrailerVote::Api.encode(CONTENT, issue: data)
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/issue/find.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/issue'
+
+module TrailerVote
+  module Api
+    class Issue
+      class Find
+        include Composable::Get
+
+        SUCCESS = MediaTypes::Issue.to_constructable.version(1)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        def initialize(configuration:, result: nil)
+          self.configuration = configuration
+          self.result = result
+        end
+
+        # @return [TrailerVote::Api::Configuration, TrailerVote::Api::Issue::Create]
+        def back
+          backtrack = result
+          backtrack = result.back while backtrack&.is_a?(self.class)
+          backtrack || configuration
+        end
+
+        def call(url: nil)
+          return self if ok? || !url
+          guard_network_errors do
+            branch(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+          end
+        end
+
+        def data
+          to_h[:issue]
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/issue.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+require 'trailer_vote/api/configuration'
+
+module TrailerVote
+  module Api
+    class Configuration
+      # @return [TrailerVote::Api::Issue::Find] issues attached to the credentials
+      def issue
+        Issue.new(configuration: self)
+      end
+    end
+
+    class Issue
+      def initialize(configuration:)
+        self.configuration = configuration
+      end
+
+      def back
+        configuration
+      end
+
+      private
+
+      attr_accessor :configuration
+    end
+  end
+end
+
+TrailerVote::MediaTypes::Issue.register

data/lib/trailer_vote/api/version.rb

@@ -2,6 +2,6 @@
 
 module TrailerVote
   module Api
-    VERSION = '0.8.2'
+    VERSION = '0.8.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailer_vote-api
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -205,6 +205,9 @@ files:
 - lib/trailer_vote/api/configuration.rb
 - lib/trailer_vote/api/errors.rb
 - lib/trailer_vote/api/fallback_content_types.rb
+- lib/trailer_vote/api/issue.rb
+- lib/trailer_vote/api/issue/create.rb
+- lib/trailer_vote/api/issue/find.rb
 - lib/trailer_vote/api/links.rb
 - lib/trailer_vote/api/place.rb
 - lib/trailer_vote/api/place/create.rb