cybercoach 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59526a9235348317412b0f880b808b23357827aa
-  data.tar.gz: 77285e272d541197cd65e1752fae2d96f0ff78ce
+  metadata.gz: a673d760d6a53d29163f737519c2c1abd8d45301
+  data.tar.gz: efcda8eca1e90172b343bc89e8ba2704ef71af10
 SHA512:
-  metadata.gz: fe5ffcf504246b9f3ac0b9203f3d5457676ab3cdee654b6cc4d5c85cabac93e63e6f08d1b9e3b9f4f7384254be23e8b57ca4a3bbae0a8bce4d4b84c0bd323be5
-  data.tar.gz: 29f7d4a1542fccd1ce2ec78c14112c8aa55ec34b0492ff2963c82e347135e8acdb6fac6bd2bf5eef4a4888db5b659a92988687330f2de93499e1bbcf6127544a
+  metadata.gz: c648893b1b4f85f161fa54233a114d05ca20c81cbda73627e5539d112feaec2ed4fce19e00824b7c155542ae476b068810fb3516cfe60e3ad6430c8bf3dfed4a
+  data.tar.gz: f860054778668ae3f3f80658e11281175e56f622b18140e04f5d7cd7ece05f2250e1d20f2e1d0e4baab70a3c5f2a9c2d3536a980bebc7df376cc16f046a56e3e

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 
+## v0.4.0
+
+ - resources can be initialized with a hash
+ - resource invalidation is optional
+
 ## v0.3.0
 
  - `public_visble` -> `privacy_level`
  - `PrivacyLevel`s introduced
  - added `User.authentication()` to get authentication options
- - Gem is actually a Gem...
+ - Gem is actually a Gem...

data/lib/cybercoach.rb

@@ -6,6 +6,7 @@ require 'cybercoach/settings'
 require 'cybercoach/format_not_supported_error'
 require 'cybercoach/http_error'
 require 'cybercoach/subclass_responsibility_error'
+require 'cybercoach/hash_initializable'
 require 'cybercoach/abstract_resource'
 require 'cybercoach/resource'
 require 'cybercoach/resource_page'

data/lib/cybercoach/abstract_resource.rb

@@ -11,6 +11,11 @@ module CyberCoach
     #
     include HTTParty
 
+    #
+    # Instance variables can be initialized with a hash.
+    #
+    include HashInitializable
+
     #
     # :private_attr: options
     # The options that are always sent with each request, e.g. :basic_auth.
@@ -23,15 +28,26 @@ module CyberCoach
 
     headers 'content-type' => 'application/json', 'accept' => 'application/json'
     format :json
-    base_uri CyberCoach::Settings::SERVER_URI
+    base_uri Settings::SERVER_URI
 
     #
     # Creates an AbstractResource.
+    # hash:: A hash of values to set on instance variables.
     #
-    def initialize
-      super
-      @uri = nil
+    def initialize(hash = {})
+      super()
       @options = {}
+      initialize_with(hash)
+    end
+
+    #
+    # :category: Invalidation
+    #
+    # Invalidates the uri and the options.
+    #
+    def invalidate
+      invalidate_uri
+      invalidate_options
     end
 
     #
@@ -41,16 +57,18 @@ module CyberCoach
     # Gets the URI from the response and reads itself again.
     # Raises HttpError if the request is unsuccessful.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def read(options = {})
-      invalidate_uri
-      invalidate_options
+    def read(options = {}, invalidate = true)
+      if invalidate
+        self.invalidate
+      end
       options = @options.merge(options)
       response = self.class.get(@uri, options)
       if response.success?
         deserialize(response)
       else
-        raise HttpError.new(response.response)
+        fail HttpError, response.response
       end
     end
 
@@ -66,7 +84,7 @@ module CyberCoach
       elsif format == :json
         to_serializable.to_json
       else
-        raise FormatNotSupportedError.new
+        fail FormatNotSupportedError
       end
     end
 
@@ -115,7 +133,7 @@ module CyberCoach
     # Must be overridden in a subclass.
     #
     def singular_name
-      raise SubclassResponsibilityError.new
+      fail SubclassResponsibilityError
     end
 
     #
@@ -127,7 +145,7 @@ module CyberCoach
     # Must be overridden in a subclass.
     #
     def plural_name
-      raise SubclassResponsibilityError.new
+      fail SubclassResponsibilityError
     end
 
     #
@@ -158,5 +176,9 @@ module CyberCoach
     #
     def invalidate_options
     end
+
+    def initializable_with
+      [:uri]
+    end
   end
 end

data/lib/cybercoach/entry.rb

@@ -162,5 +162,9 @@ module CyberCoach
         @uri = "#{resource_base_uri}#{@id}/"
       end
     end
+
+    def initializable_with
+      super + [:subscription, :comment, :location, :duration, :privacy_level]
+    end
   end
 end

data/lib/cybercoach/hash_initializable.rb

@@ -0,0 +1,50 @@
+module CyberCoach
+  #
+  # Mixin for an object that be initialized with a hash.
+  #
+  module HashInitializable
+    #
+    # Installs class and instance methods in the class it is included in.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    #
+    # The class methods to install.
+    #
+    module ClassMethods
+    end
+
+    #
+    # The instance methods to install.
+    #
+    module InstanceMethods
+      #
+      # :category: Initialization
+      #
+      # Returns a list of instance variables it can be initialized with.
+      #
+      def initializable_with
+        fail SubclassResponsibilityError
+      end
+
+      #
+      # :category: Initialization
+      #
+      # Initializes the instance variables with a name in the specified names to
+      # the values mapped in the specified hash.
+      # hash:: A hash of values to set on instance variables.
+      # names:: The names of the instance variables to set.
+      #
+      def initialize_with(hash)
+        initializable_with.each do |name|
+          if hash.key? name
+            instance_variable_set(:"@#{name}", hash[name])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cybercoach/pageable.rb

@@ -21,10 +21,11 @@ module CyberCoach
       #
       # Returns the first page of resources.
       # options:: A hash of options to send with the request.
+      # invalidate:: Invalidates it when true, skips invalidation when false.
       #
-      def read_all(options = {})
-        page = ResourcePage.new(self)
-        page.read(options)
+      def read_all(options = {}, invalidate = true)
+        page = ResourcePage.new(type: self)
+        page.read(options, invalidate)
         page
       end
     end

data/lib/cybercoach/partnership.rb

@@ -147,5 +147,9 @@ module CyberCoach
         @uri = "#{resource_base_uri}#{@proposer.username};#{@proposed.username}/"
       end
     end
+
+    def initializable_with
+      super + [:proposer, :proposed, :privacy_level]
+    end
   end
 end

data/lib/cybercoach/post_createable.rb

@@ -29,10 +29,12 @@ module CyberCoach
       # Gets the URI from the response and reads itself again.
       # Raises HttpError if the request is unsuccessful.
       # options:: A hash of options to send with the request.
+      # invalidate:: Invalidates it when true, skips invalidation when false.
       #
-      def create(options = {})
-        invalidate_uri
-        invalidate_options
+      def create(options = {}, invalidate = true)
+        if invalidate
+          self.invalidate
+        end
         options = @options.merge(options).merge(
           body: serialize
         )
@@ -41,7 +43,7 @@ module CyberCoach
           @uri = response.headers['location']
           read(options)
         else
-          raise HttpError.new(response.response)
+          fail HttpError, response.response
         end
       end
     end

data/lib/cybercoach/put_createable.rb

@@ -29,10 +29,12 @@ module CyberCoach
       # Reads itself from the response.
       # Raises HttpError if the request is unsuccessful.
       # options:: A hash of options to send with the request.
+      # invalidate:: Invalidates it when true, skips invalidation when false.
       #
-      def create(options = {})
-        invalidate_uri
-        invalidate_options
+      def create(options = {}, invalidate = true)
+        if invalidate
+          self.invalidate
+        end
         options = @options.merge(options).merge(
           body: serialize
         )
@@ -40,7 +42,7 @@ module CyberCoach
         if response.success?
           deserialize(response)
         else
-          raise HttpError.new(response.response)
+          fail HttpError, response.response
         end
       end
     end

data/lib/cybercoach/resource.rb

@@ -15,9 +15,10 @@ module CyberCoach
     # Must be overridden in a subclass.
     # May use PutCreateable or PostCreateable.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def create(_options = {})
-      raise SubclassResponsibilityError.new
+    def create(options = {}, invalidate = true)
+      fail SubclassResponsibilityError
     end
 
     #
@@ -27,10 +28,12 @@ module CyberCoach
     # Reads itself from the response.
     # Raises HttpError if the request is unsuccessful.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def update(options = {})
-      invalidate_uri
-      invalidate_options
+    def update(options = {}, invalidate = true)
+      if invalidate
+        self.invalidate
+      end
       options = @options.merge(options).merge(
         body: serialize
       )
@@ -38,7 +41,7 @@ module CyberCoach
       if response.success?
         deserialize(response)
       else
-        raise HttpError.new(response.response)
+        fail HttpError, response.response
       end
     end
 
@@ -49,16 +52,18 @@ module CyberCoach
     # Reads itself from the response.
     # Raises HttpError if the request is unsuccessful.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def delete(options = {})
-      invalidate_uri
-      invalidate_options
+    def delete(options = {}, invalidate = true)
+      if invalidate
+        self.invalidate
+      end
       options = @options.merge(options)
       response = self.class.delete(@uri, options)
       if response.success?
         deserialize(response)
       else
-        raise HttpError.new(response.response)
+        fail HttpError, response.response
       end
     end
 
@@ -90,5 +95,9 @@ module CyberCoach
       serializable['id'] = @id
       serializable
     end
+
+    def initializable_with
+      super + [:id]
+    end
   end
 end

data/lib/cybercoach/resource_page.rb

@@ -49,11 +49,13 @@ module CyberCoach
 
     #
     # Create a ResourcePage of the specified type.
-    # type:: The class of resource to page.
+    # hash:: A hash of values to set on instance variables. :type is required.
     #
-    def initialize(type)
-      super()
-      @type = type
+    def initialize(hash = {})
+      unless hash.key? :type
+        fail ArgumentError, 'requires a :type entry in the hash'
+      end
+      super(hash)
     end
 
     #
@@ -62,20 +64,23 @@ module CyberCoach
     # Returns the next page.
     # Raises NoNextPageError if the is none.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def next(options = {})
+    def next(options = {}, invalidate = true)
       if @next.nil?
-        raise NoNextPageError.new
+        fail NoNextPageError
+      end
+      if invalidate
+        self.invalidate
       end
-      invalidate_options
       options = @options.merge(options)
       response = self.class.get(@next['href'], options)
       if response.success?
-        page = self.class.new(@type)
+        page = self.class.new(type: @type)
         page.deserialize(response)
         page
       else
-        raise HttpError.new(response.response)
+        fail HttpError, response.response
       end
     end
 
@@ -85,20 +90,23 @@ module CyberCoach
     # Returns the previous page.
     # Raises NoPreviousPageError if the is none.
     # options:: A hash of options to send with the request.
+    # invalidate:: Invalidates it when true, skips invalidation when false.
     #
-    def previous(options = {})
+    def previous(options = {}, invalidate = true)
       if @previous.nil?
-        raise NoPreviousPageError.new
+        fail NoPreviousPageError
+      end
+      if invalidate
+        self.invalidate
       end
-      invalidate_options
       options = @options.merge(options)
       response = self.class.get(@previous['href'], options)
       if response.success?
-        page = self.class.new(@type)
+        page = self.class.new(type: @type)
         page.deserialize(response)
         page
       else
-        raise HttpError.new(response.response)
+        fail HttpError, response.response
       end
     end
 
@@ -187,5 +195,9 @@ module CyberCoach
     def invalidate_uri
       @uri = resource_base_uri
     end
+
+    def initializable_with
+      super + [:type, :start, :end, :size]
+    end
   end
 end

data/lib/cybercoach/sport.rb

@@ -100,5 +100,9 @@ module CyberCoach
         @uri = "#{resource_base_uri}#{@name}/"
       end
     end
+
+    def initializable_with
+      super + [:name, :description]
+    end
   end
 end

data/lib/cybercoach/subscription.rb

@@ -141,5 +141,9 @@ module CyberCoach
         @uri = resource_base_uri
       end
     end
+
+    def initializable_with
+      super + [:subscriber, :sport, :privacy_level]
+    end
   end
 end