wes-data-api 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 606729653ad9bae7a4999e9eb0e09407b5dffdf0
-  data.tar.gz: 8ee3f5734be6d44e0cdf47b44215cd88d3a4455a
+  metadata.gz: 023c6f11132ce8f89854c1e0ee9b1e825bc6011c
+  data.tar.gz: 10f92314070fe552e5a6e3f7509f3bea8d26508f
 SHA512:
-  metadata.gz: 5a007f038b340a1579df1af88a44fec721cb1e17cf535bc88c3736b98e74043dc880e9e5fd830a1a58568a363ccde8a82dbc4596af34ddface88cbc9f8b3e32e
-  data.tar.gz: 7dd9adbc5e419267185a412212ce82724f6a0ef2910a240f4484ae7469dbc2980fe8d68bf5035379de0602886ab522a375f057c06b82eb66ff90e3e4b199803b
+  metadata.gz: da26e0f3cff0d69a526487a409cdf0d111bd9ebf7184e5fd037fb0c34f0086fa3a4103292a9ef20c4bf94f96e0f4c028ad5d86df59500ce4d80ff3aa109884e5
+  data.tar.gz: e2ab74fcca14e06caca472450070652e383188edcb46d73e9d3574777f95cb48a836ffe5c78b32f0bb06877fa4221614b9e0dc9d02992ee2b2ae326932bb0398

data/lib/wes/data/api.rb

@@ -1,11 +1,11 @@
 require "json"
 require "ostruct"
 require "wes/data/api/configuration"
-require "wes/data/api/version"
 
 module Wes
   module Data
     module API
+      VERSION = "4.0.0".freeze
     end
   end
 end

data/lib/wes/data/api/base.rb

@@ -4,77 +4,26 @@ require "wes/data/api/configuration"
 module Wes
   module Data
     module API
-      class Base
-        attr_reader :attributes
-
-        def initialize(attributes)
-          @attributes = attributes
-        end
-
-        class << self
-          def client
-            Client.new
-          end
-
-          def configuration
-            Configuration
-          end
-
-          def find(route)
-            new(client.get(route).first)
-          end
-
-          def create(route, payload = {})
-            new(client.post(route, payload).first)
-          end
-
-          def routes
-            configuration.routes
-          end
-
-          def mapped_objects(route)
-            client.get(route).map do |item|
-              new(item)
-            end
-          end
-        end
-
-        def exist?
-          !attributes.nil?
+      module Base
+        def add_state(route, state = nil)
+          return route unless state
+          "#{route}/#{state}"
         end
 
-        def method_missing(method_sym)
-          attributes.to_h.fetch(method_sym, nil)
-        end
-
-        def update(route, changes)
-          @attributes = client.put(
-            route,
-            @attributes.to_h.merge(changes)
-          ).first
-          self
-        end
-
-        protected
-
-        def id_set?
-          raise(ArgumentError, "ID not set for #{self.class.name}") if id.nil?
+        def client
+          Client.new
         end
 
-        def id
-          attributes.id
+        def configuration
+          Configuration
         end
 
-        def client
-          self.class.client
+        def map_objects(records, klass)
+          records.map { |r| klass.new(r) }
         end
 
         def routes
-          self.class.routes
-        end
-
-        def mapped_objects(route)
-          self.class.mapped_objects(route)
+          configuration.routes
         end
       end
     end

data/lib/wes/data/api/billing.rb

@@ -1,27 +1,37 @@
 require "wes/data/api/base"
+require "wes/data/api/model/billing"
 
 module Wes
   module Data
     module API
-      class Billing < Base
+      class Billing
         class << self
+          include Base
+
           def create(data)
-            attributes = client.post("#{routes.billing}", data).first
-            new(attributes)
+            attributes = client.post(routes.billing, data).first
+            model_klass.new(attributes)
           end
 
           def find(key, value)
+            attributes = client.get(find_route(key, value)).first
+            model_klass.new(attributes)
+          end
+
+          private
+
+          def find_route(key, value)
             case key
             when :id
-              super("#{routes.billing}/#{value}")
+              [routes.billing, value].join("/")
             when :user_id
-              super("#{routes.user}/#{value}/billing")
+              [routes.billing, value, routes.billing].join("/")
             end
           end
-        end
 
-        def update(changes)
-          super("#{routes.billing}/#{id}", changes)
+          def model_klass
+            Wes::Data::API::Model::Billing
+          end
         end
       end
     end

data/lib/wes/data/api/brand.rb

@@ -1,49 +1,28 @@
-require "wes/data/api/client"
-require "wes/data/api/configuration"
+require "wes/data/api/base"
+require "wes/data/api/model/brand"
 
 module Wes
   module Data
     module API
       class Brand
-        def initialize(id = nil)
-          @id = id
-        end
-
-        def self.all
-          new.all
-        end
-
-        def self.find(id)
-          new.find id
-        end
-
-        def all
-          client.get "#{routes.brands}"
-        end
+        class << self
+          include Base
 
-        def challenges
-          raise(ArgumentError, "ID not set for Brand") if id.nil?
-          client.get "#{routes.brand}/#{id}#{routes.challenges}"
-        end
-
-        def find(id)
-          client.get("#{routes.brand}/#{id}").first
-        end
-
-        private
+          def all
+            map_objects(client.get(routes.brands), model_klass)
+          end
 
-        attr_reader :id
+          def find(_key, value)
+            route = [routes.brand, value].join("/")
+            attributes = client.get(route).first
+            model_klass.new(attributes)
+          end
 
-        def client
-          Client.new
-        end
-
-        def configuration
-          Configuration
-        end
+          private
 
-        def routes
-          configuration.routes
+          def model_klass
+            Wes::Data::API::Model::Brand
+          end
         end
       end
     end

data/lib/wes/data/api/challenge.rb

@@ -1,52 +1,32 @@
 require "wes/data/api/base"
+require "wes/data/api/model/challenge"
 
 module Wes
   module Data
     module API
-      class Challenge < Base
+      class Challenge
         class << self
-          def find(id)
-            super("#{routes.challenge}/#{id}")
-          end
+          include Base
 
-          def all
-            mapped_objects(routes.challenges)
+          def find(_key, value)
+            route = [routes.challenge, value].join("/")
+            attributes = client.get(route).first
+            model_klass.new(attributes)
           end
 
-          def closed
-            mapped_objects("#{routes.challenges}/closed")
+          def all(state = nil)
+            route = add_state(routes.challenges, state)
+            map_objects(
+              client.get(route), model_klass
+            )
           end
 
-          def drafts
-            mapped_objects("#{routes.challenges}/drafts")
-          end
+          private
 
-          def open
-            mapped_objects("#{routes.challenges}/open")
+          def model_klass
+            Wes::Data::API::Model::Challenge
           end
         end
-
-        def purchased_videos
-          id_set?
-          mapped_objects("#{routes.challenge}/#{id}#{routes.videos}/purchased")
-        end
-
-        def rewards
-          id_set?
-          mapped_objects("#{routes.challenge}/#{id}/rewards")
-        end
-
-        def users(state = nil)
-          id_set?
-          route = state ? "#{routes.challenge}/#{id}/users/#{state}"
-                        : "#{routes.challenge}/#{id}/users"
-          mapped_objects(route)
-        end
-
-        def videos
-          id_set?
-          mapped_objects("#{routes.challenge}/#{id}#{routes.videos}")
-        end
       end
     end
   end

data/lib/wes/data/api/client.rb

@@ -27,7 +27,7 @@ module Wes
         end
 
         def response(api_response)
-          Response.build api_response
+          Response.new(api_response).build
         end
       end
     end

data/lib/wes/data/api/collective.rb

@@ -1,32 +1,25 @@
-require "wes/data/api/client"
-require "wes/data/api/configuration"
+require "wes/data/api/base"
+require "wes/data/api/model/collective"
 
 module Wes
   module Data
     module API
       class Collective
-        def self.all
-          new.all
-        end
-
-        def all
-          client.get "#{routes.collectives}"
-        end
-
-        private
+        class << self
+          include Base
 
-        attr_reader :id
+          def all
+            map_objects(
+              client.get(routes.collectives),
+              model_klass
+            )
+          end
 
-        def client
-          Client.new
-        end
-
-        def configuration
-          Configuration
-        end
+          private
 
-        def routes
-          configuration.routes
+          def model_klass
+            Wes::Data::API::Model::Collective
+          end
         end
       end
     end

data/lib/wes/data/api/configuration.rb

@@ -1,3 +1,5 @@
+require "wes/data/api/routes"
+
 module Wes
   module Data
     module API
@@ -6,7 +8,7 @@ module Wes
 
         class << self
           attr_accessor :endpoint
-          attr_writer   :routes, :version
+          attr_writer   :version
 
           def configure(&block)
             yield self
@@ -14,7 +16,7 @@ module Wes
           end
 
           def routes
-            OpenStruct.new @routes
+            Routes.hash
           end
 
           def version

data/lib/wes/data/api/model/base.rb

@@ -0,0 +1,57 @@
+module Wes
+  module Data
+    module API
+      module Model
+        class Base
+          protected
+
+          attr_reader :attributes
+
+          def initialize(attributes)
+            @attributes = attributes
+            id_set?
+          end
+
+          def add_state(route, state)
+            return route unless state
+            "#{route}/#{state}"
+          end
+
+          def client
+            Client.new
+          end
+
+          def configuration
+            Configuration
+          end
+
+          def exist?
+            !attributes.nil?
+          end
+
+          def id
+            attributes.id
+          end
+
+          def map_objects(records, klass)
+            records.map { |r| klass.new(r) }
+          end
+
+          def method_missing(sym, *_args, &_block)
+            attributes.to_h.fetch(sym, nil)
+          end
+
+          def routes
+            configuration.routes
+          end
+
+          private
+
+          def id_set?
+            raise(ArgumentError, "ID not set for #{self.class.name}") if id.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/billing.rb

@@ -0,0 +1,20 @@
+require "wes/data/api/model/base"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Billing < Base
+          def update(changes)
+            route = [routes.billing, id].join("/")
+            attributes = client.put(
+              route, attributes.to_h.merge(changes)
+            ).first
+
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/brand.rb

@@ -0,0 +1,19 @@
+require "wes/data/api/model/base"
+require "wes/data/api/model/challenge"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Brand < Base
+          def challenges
+            route = [routes.brand, id, routes.challenges].join("/")
+            map_objects(
+              client.get(route), Wes::Data::API::Model::Challenge
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/challenge.rb

@@ -0,0 +1,39 @@
+require "wes/data/api/model/base"
+require "wes/data/api/model/challenge_reward"
+require "wes/data/api/model/user"
+require "wes/data/api/model/video"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Challenge < Base
+          def rewards
+            route = [routes.challenge, id, routes.rewards].join("/")
+            map_objects(
+              client.get(route), Wes::Data::API::Model::ChallengeReward
+            )
+          end
+
+          def users(state = nil)
+            route = add_state(
+              [routes.challenge, id, routes.users].join("/"), state
+            )
+            map_objects(
+              client.get(route), Wes::Data::API::Model::User
+            )
+          end
+
+          def videos(state = nil)
+            route = add_state(
+              [routes.challenge, id, routes.videos].join("/"), state
+            )
+            map_objects(
+              client.get(route), Wes::Data::API::Model::Video
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/challenge_reward.rb

@@ -0,0 +1,12 @@
+require "wes/data/api/model/base"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class ChallengeReward < Base
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/collective.rb

@@ -0,0 +1,12 @@
+require "wes/data/api/model/base"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Collective < Base
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/submission.rb

@@ -0,0 +1,19 @@
+require "wes/data/api/model/base"
+require "wes/data/api/model/video"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Submission < Base
+          def videos
+            route = [routes.submission, id, routes.videos].join("/")
+            map_objects(
+              client.get(route), Wes::Data::API::Model::Video
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/user.rb

@@ -0,0 +1,67 @@
+require "wes/data/api/model/base"
+require "wes/data/api/model/collective"
+require "wes/data/api/model/submission"
+require "wes/data/api/model/video"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class User < Base
+          def submissions(state = nil)
+            route = add_state(
+              [routes.user, id, routes.submissions].join("/"), state
+            )
+            map_objects(
+              client.get(route), Wes::Data::API::Model::Submission
+            )
+          end
+
+          def update(changes)
+            route = [routes.user, id].join("/")
+            attributes = client.put(
+              route, attributes.to_h.merge(changes)
+            ).first
+
+            self
+          end
+
+          def videos
+            route = [routes.user, id, routes.videos].join("/")
+            map_objects(
+              client.get(route), Wes::Data::API::Model::Video
+            )
+          end
+
+          def assign_collectives(collective_ids)
+            validate_collectives(collective_ids)
+            records = create_collectives(collective_ids)
+            map_objects(records, Wes::Data::API::Model::Collective)
+          end
+
+          protected
+
+          def create_collectives(collective_ids)
+            client.post(
+              [routes.user, id, routes.collectives].join("/"),
+              collective_ids
+            )
+          end
+
+          def id
+            attributes.auth0_id
+          end
+
+          def validate_collectives(input)
+            unless input.is_a?(Array)
+              raise ArgumentError, "List of collective IDs must be an array"
+            end
+            if input.empty?
+              raise StandardError, "List of collective IDs is empty"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/model/video.rb

@@ -0,0 +1,12 @@
+require "wes/data/api/model/base"
+
+module Wes
+  module Data
+    module API
+      module Model
+        class Video < Base
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/request.rb

@@ -6,69 +6,59 @@ module Wes
   module Data
     module API
       class Request
-        def self.get(path)
-          new.get path
-        end
-
-        def self.post(path, options = {})
-          new.post(path, options)
-        end
-
-        def self.put(path, options = {})
-          new.put(path, options)
-        end
-
-        def get(path)
-          connection.get do |r|
-            r.url complete_path(path)
-            r.options.timeout = TIMEOUT
+        class << self
+          def get(path)
+            connection.get do |r|
+              r.options.timeout = TIMEOUT
+              r.url             complete_path(path)
+            end
           end
-        end
 
-        def post(path, options)
-          connection.post do |r|
-            r.body = options.to_json
-            r.headers["Content-Type"] = "application/json"
-            r.url complete_path(path)
-            r.options.timeout = TIMEOUT
+          def post(path, options)
+            connection.post do |r|
+              r.body                    = options.to_json
+              r.headers["Content-Type"] = "application/json"
+              r.options.timeout         = TIMEOUT
+              r.url                     complete_path(path)
+            end
           end
-        end
 
-        def put(path, options)
-          connection.put do |r|
-            r.body = options.to_json
-            r.headers["Content-Type"] = "application/json"
-            r.url complete_path(path)
-            r.options.timeout = TIMEOUT
+          def put(path, options)
+            connection.put do |r|
+              r.body                    = options.to_json
+              r.headers["Content-Type"] = "application/json"
+              r.options.timeout         = TIMEOUT
+              r.url complete_path(path)
+            end
           end
-        end
 
-        private
+          private
 
-        TIMEOUT = 2
+          TIMEOUT = 2
 
-        def complete_path(path)
-          "/#{version}#{path}"
-        end
+          def complete_path(path)
+            ["/", version, path].join("/")
+          end
 
-        def configuration
-          Configuration
-        end
+          def configuration
+            Configuration
+          end
 
-        def connection
-          Faraday.new(:url => endpoint) do |c|
-            c.adapter Faraday.default_adapter
-            c.use Faraday::Response::RaiseError
-            c.response :json, :content_type => /\bjson$/
+          def connection
+            Faraday.new(:url => endpoint) do |c|
+              c.adapter  Faraday.default_adapter
+              c.use      Faraday::Response::RaiseError
+              c.response :json, :content_type => /\bjson$/
+            end
           end
-        end
 
-        def endpoint
-          configuration.endpoint
-        end
+          def endpoint
+            configuration.endpoint
+          end
 
-        def version
-          configuration.version
+          def version
+            configuration.version
+          end
         end
       end
     end

data/lib/wes/data/api/response.rb

@@ -5,15 +5,11 @@ module Wes
   module Data
     module API
       class Response
-        def self.build(response)
-          new(response).data
-        end
-
         def initialize(response)
           @response = response
         end
 
-        def data
+        def build
           raise unexpected_error unless response.body
           data = response.body["data"] || raise(response_error)
           data.map { |e| OpenStruct.new e }

data/lib/wes/data/api/routes.rb

@@ -0,0 +1,27 @@
+module Wes
+  module Data
+    module API
+      class Routes
+        class << self
+          def hash
+            OpenStruct.new(
+              :billing     => "billing",
+              :brand       => "brand",
+              :brands      => "brands",
+              :challenge   => "challenge",
+              :challenges  => "challenges",
+              :collectives => "collectives",
+              :rewards     => "rewards",
+              :submission  => "submission",
+              :submissions => "submissions",
+              :user        => "user",
+              :users       => "users",
+              :video       => "video",
+              :videos      => "videos"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wes/data/api/submission.rb

@@ -1,49 +1,29 @@
-require "wes/data/api/client"
-require "wes/data/api/configuration"
+require "wes/data/api/base"
+require "wes/data/api/model/submission"
 
 module Wes
   module Data
     module API
       class Submission
-        def initialize(id = nil)
-          @id = id
-        end
-
-        def self.create(options)
-          new.create options
-        end
-
-        def self.find(id)
-          new.find id
-        end
-
-        def create(options)
-          client.post(routes.submission, options).first
-        end
+        class << self
+          include Base
 
-        def find(id)
-          client.get("#{routes.submission}/#{id}").first
-        end
-
-        def videos
-          raise(ArgumentError, "ID not set for Submission") if id.nil?
-          client.get "#{routes.submission}/#{id}#{routes.videos}"
-        end
-
-        private
+          def create(options)
+            attributes = client.post(routes.submission, options).first
+            model_klass.new(attributes)
+          end
 
-        attr_reader :id
+          def find(_key, value)
+            route = [routes.submission, value].join("/")
+            attributes = client.get(route).first
+            model_klass.new(attributes)
+          end
 
-        def client
-          Client.new
-        end
-
-        def configuration
-          Configuration
-        end
+          private
 
-        def routes
-          configuration.routes
+          def model_klass
+            Wes::Data::API::Model::Submission
+          end
         end
       end
     end

data/lib/wes/data/api/user.rb

@@ -1,67 +1,48 @@
 require "wes/data/api/base"
+require "wes/data/api/model/user"
 
 module Wes
   module Data
     module API
-      class User < Base
+      class User
         class << self
+          include Base
+
           def all
-            mapped_objects(routes.users)
+            map_objects(
+              client.get(routes.users), model_klass
+            )
           end
 
           def create(id)
-            super("#{routes.user}/#{id}")
+            route = [routes.user, id].join("/")
+            attributes = client.post(route).first
+            model_klass.new(attributes)
           end
 
           def find(key, value)
+            attributes = client.get(find_route(key, value)).first
+            model_klass.new(attributes)
+          end
+
+          private
+
+          def find_route(key, value)
             case key
             when :id
-              super("#{routes.user}/#{value}")
+              [routes.user, value].join("/")
             else
-              super("#{routes.user}?#{key}=#{value}")
+              "#{routes.user}?#{key}=#{value}"
             end
           end
-        end
 
-        def closed_submissions
-          mapped_objects("#{routes.user}/#{id}#{routes.submissions}/closed")
-        end
-
-        def open_submissions
-          mapped_objects("#{routes.user}/#{id}#{routes.submissions}/open")
-        end
-
-        def submissions
-          mapped_objects("#{routes.user}/#{id}#{routes.submissions}")
-        end
-
-        def videos
-          mapped_objects("#{routes.user}/#{id}#{routes.videos}")
-        end
-
-        def update(changes)
-          super("#{routes.user}/#{id}", changes)
-        end
-
-        def assign_collectives(collective_ids)
-          unless collective_ids.kind_of?(Array)
-            raise ArgumentError, "List of collective ids must be an array"
+          def id
+            attributes.auth0_id
           end
 
-          if collective_ids.empty?
-            raise StandardError, "At least one collective_id must be specified"
+          def model_klass
+            Wes::Data::API::Model::User
           end
-
-          client.post(
-            [routes.user, id, "collectives"].join("/"),
-            collective_ids
-          )
-        end
-
-        private
-
-        def id
-          attributes.auth0_id
         end
       end
     end

data/lib/wes/data/api/video.rb

@@ -1,30 +1,23 @@
-require "wes/data/api/client"
-require "wes/data/api/configuration"
+require "wes/data/api/base"
+require "wes/data/api/model/video"
 
 module Wes
   module Data
     module API
       class Video
-        def self.create(options)
-          new.create options
-        end
-
-        def create(options)
-          client.post(routes.video, options).first
-        end
+        class << self
+          include Base
 
-        private
+          def create(options)
+            attributes = client.post(routes.video, options).first
+            model_klass.new(attributes)
+          end
 
-        def client
-          Client.new
-        end
-
-        def configuration
-          Configuration
-        end
+          private
 
-        def routes
-          configuration.routes
+          def model_klass
+            Wes::Data::API::Model::Video
+          end
         end
       end
     end

data/wes-data-api.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "wes/data/api/version"
+require "wes/data/api"
 
 Gem::Specification.new do |spec|
   spec.name          = "wes-data-api"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wes-data-api
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 4.0.0
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,11 +126,20 @@ files:
 - lib/wes/data/api/configuration.rb
 - lib/wes/data/api/error/response.rb
 - lib/wes/data/api/error/unexpected.rb
+- lib/wes/data/api/model/base.rb
+- lib/wes/data/api/model/billing.rb
+- lib/wes/data/api/model/brand.rb
+- lib/wes/data/api/model/challenge.rb
+- lib/wes/data/api/model/challenge_reward.rb
+- lib/wes/data/api/model/collective.rb
+- lib/wes/data/api/model/submission.rb
+- lib/wes/data/api/model/user.rb
+- lib/wes/data/api/model/video.rb
 - lib/wes/data/api/request.rb
 - lib/wes/data/api/response.rb
+- lib/wes/data/api/routes.rb
 - lib/wes/data/api/submission.rb
 - lib/wes/data/api/user.rb
-- lib/wes/data/api/version.rb
 - lib/wes/data/api/video.rb
 - wes-data-api.gemspec
 homepage: ''

data/lib/wes/data/api/version.rb

@@ -1,7 +0,0 @@
-module Wes
-  module Data
-    module API
-      VERSION = "3.5.0".freeze
-    end
-  end
-end