zype 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6aa476ba1a7c66b8b862c0d8b0c4188b284f456867a8d27f1fd8dca67c9acf5
-  data.tar.gz: 4c62eaddf5f63790de3d4fddd58abc7fa5cadf948e913864131dbd7c4de58a44
+  metadata.gz: 7cf3e8bab00adde7d7df2a29e8fe5a4a137e1d40da387980e60a1ca7f936f975
+  data.tar.gz: 5c10d9d038c052871c85b7e616ba3d0d2e77ec55065f2463aa343a5510fcd79e
 SHA512:
-  metadata.gz: 84a8db7a16bcae3e26763bd099bd4c38fd9d94c8a86c4d6b0a9da3ba80fd080f3763c0518f15a2f277b8fcb0946b36b6eba9f5a3b013220ffec56fac88da60e9
-  data.tar.gz: 527240894196c6be30a830e876e6b9c73be1c495fd5c695e0923a6dafc2a28c65d0dec8ff424b50f8d93a59e4fa9d38480a51986c2ae6b846207c55edcf81848
+  metadata.gz: 7c856392db6e1eec43f4c7cdedc4d1bcbf666868e3ecd56591e1cf035bd913e2701882c79c2f0e6e56215205b902961b9d2d2b5b88cc15cffc879027b8779748
+  data.tar.gz: 743bfadd075b9249f18b15d89ec6e7277f2d9df0fe7d032df45f94452c7f06e4117ed3526947100b5f729f1de23b0b63f1cbb6f316f04adebd3bce73fbe6df6c

data/lib/zype/models/base/consumers.rb

@@ -0,0 +1,50 @@
+module Zype
+  module Base
+    # Any consumer nested routes will inherit from this class
+    class Consumers < Zype::BaseModel
+      # Returns all objects for given class
+      #
+      # @param consumer_id [String] the ID of the consumer
+      # @return [Array<Hash>] the objects returned from the API
+      def all(consumer_id:)
+        client.execute(method: :get, path: "/consumers/#{consumer_id}/#{path}")
+      end
+
+      # Returns object matching ID
+      #
+      # @param consumer_id [String] the ID of the consumer
+      # @param id [String] the ID of the object
+      # @return [Hash] the object returned from the API
+      def find(consumer_id:, id:)
+        client.execute(method: :get, path: "/consumers/#{consumer_id}/#{path}/#{id}")
+      end
+
+      # Creates a new object via the API.
+      #
+      # @param consumer_id [String] ID of the consumer to assign to the object
+      # @param params [Hash] the properties of the object
+      # @return [Hash] the newly created object
+      def create(consumer_id:, params:)
+        client.execute(method: :post, path: "/consumers/#{consumer_id}/#{path}", params: params)
+      end
+
+      # Updates an existing object via the API
+      #
+      # @param consumer_id [String] the ID of the consumer
+      # @param params [Hash] the properties to be updated
+      # @return [Hash] the updated object
+      def update(consumer_id:, id:, params:)
+        client.execute(method: :put, path: "/consumers/#{consumer_id}/#{path}/#{id}", params: params)
+      end
+
+      # Deletes an existing object via the API
+      #
+      # @param consumer_id [String] the ID of the consumer
+      # @param id [String] the ID of the object
+      # @return [Hash] the deleted object
+      def delete(consumer_id:, id:)
+        client.execute(method: :delete, path: "/consumers/#{consumer_id}/#{path}/#{id}")
+      end
+    end
+  end
+end

data/lib/zype/models/consumers.rb

@@ -0,0 +1,15 @@
+module Zype
+  # Read more at https://docs.zype.com/v1.0/reference#consumers
+  #
+  # @since 0.15.0
+  class Consumers < Zype::BaseModel
+    # Initiate consumer forgot password flow.
+    # Consumer will receive forgot password email.
+    #
+    # @param email [String] email of the consumer
+    # @return [Hash] the consumer returned from the API
+    def forgot_password(email:)
+      client.execute(method: :put, path: "/#{path}/forgot_password", params: { email: email })
+    end
+  end
+end

data/lib/zype/models/pin.rb

@@ -0,0 +1,33 @@
+module Zype
+  # Read more at https://docs.zype.com/v1.0/reference#device-linking
+  #
+  # @since 0.15.0
+  class Pin < Zype::BaseModel
+    # Retrieve the pin for the device
+    #
+    # @param linked_device_id [String]
+    # @return [Hash] the device pin
+    def status(linked_device_id:)
+      client.execute(method: :get, path: '/pin/status', params: { linked_device_id: linked_device_id })
+    end
+
+    # Create the device pin
+    #
+    # @param linked_device_id [String]
+    # @return [Hash] the device pin
+    def acquire(linked_device_id:)
+      client.execute(method: :post, path: '/pin/acquire', params: { linked_device_id: linked_device_id })
+    end
+
+    #
+    # @return [Hash] the consumer
+    def link(consumer_id:, pin:)
+      client.execute(method: :put, path: '/pin/link', params: { consumer_id: consumer_id, pin: pin })
+    end
+
+    # @return [Hash] the consumer
+    def unlink(consumer_id:, pin:)
+      client.execute(method: :put, path: '/pin/unlink', params: { consumer_id: consumer_id, pin: pin })
+    end
+  end
+end

data/lib/zype/models/playlist_entitlements.rb

@@ -0,0 +1,13 @@
+module Zype
+  # Read more at https://docs.zype.com/v1.0/reference#playlist-entitlements
+  #
+  # @since 0.15.0
+  class PlaylistEntitlements < Zype::Base::Consumers
+
+    private
+
+    def path
+      @path = 'playlists'
+    end
+  end
+end

data/lib/zype/models/video_entitlements.rb

@@ -0,0 +1,19 @@
+module Zype
+  # Read more at https://docs.zype.com/v1.0/reference#video-entitlements
+  #
+  # @since 0.15.0
+  class VideoEntitlements < Zype::Base::Consumers
+    # Checks if the consumer is entitled to watch the video
+    #
+    # @param video_id [String] ID of the video
+    # @param access_token [String] Access token used to identify the consumer
+    # @return Hash
+    def entitled(video_id:, access_token:)
+      client.execute(method: :get, path: "/videos/#{video_id}/entitled", params: { access_token: access_token })
+    end
+
+    def path
+      @path = 'videos'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zype
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Zype
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,10 +66,12 @@ files:
 - lib/zype/configuration.rb
 - lib/zype/models/apps.rb
 - lib/zype/models/base/categories.rb
+- lib/zype/models/base/consumers.rb
 - lib/zype/models/base/playlists.rb
 - lib/zype/models/base/videos.rb
 - lib/zype/models/categories.rb
 - lib/zype/models/category_content_rules.rb
+- lib/zype/models/consumers.rb
 - lib/zype/models/device_categories.rb
 - lib/zype/models/devices.rb
 - lib/zype/models/encoders.rb
@@ -77,8 +79,10 @@ files:
 - lib/zype/models/live_events.rb
 - lib/zype/models/live_manifests.rb
 - lib/zype/models/manifests.rb
+- lib/zype/models/pin.rb
 - lib/zype/models/players.rb
 - lib/zype/models/playlist_content_rules.rb
+- lib/zype/models/playlist_entitlements.rb
 - lib/zype/models/playlists.rb
 - lib/zype/models/program_guides.rb
 - lib/zype/models/segments.rb
@@ -86,6 +90,7 @@ files:
 - lib/zype/models/subtitles.rb
 - lib/zype/models/users.rb
 - lib/zype/models/video_content_rules.rb
+- lib/zype/models/video_entitlements.rb
 - lib/zype/models/video_imports.rb
 - lib/zype/models/video_sources.rb
 - lib/zype/models/videos.rb