cybercoach 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad6ac23fea3b1fa04a72a28e36810290d1cc9186
-  data.tar.gz: 02d1a6e7ca0dfa735fc8e503216803b3320800b6
+  metadata.gz: 59526a9235348317412b0f880b808b23357827aa
+  data.tar.gz: 77285e272d541197cd65e1752fae2d96f0ff78ce
 SHA512:
-  metadata.gz: 86a230ed3186e6c1c6f6cbc3725815703f8ab460a9ef38720013e71950aedd35a5d953ffd7b522521a6f696163e1a5d3dea3bb57a4b45966013014f330d6441c
-  data.tar.gz: 096007e2140994a8af7dd3a0ffad2d6f690c8b95e4357b26bfaa76f7902a0c079fb51ec13df8e53faf8c10d4d43c22ba2337792b4bff82f38e75482d6fea0fff
+  metadata.gz: fe5ffcf504246b9f3ac0b9203f3d5457676ab3cdee654b6cc4d5c85cabac93e63e6f08d1b9e3b9f4f7384254be23e8b57ca4a3bbae0a8bce4d4b84c0bd323be5
+  data.tar.gz: 29f7d4a1542fccd1ce2ec78c14112c8aa55ec34b0492ff2963c82e347135e8acdb6fac6bd2bf5eef4a4888db5b659a92988687330f2de93499e1bbcf6127544a

data/.gitignore

@@ -0,0 +1,45 @@
+*.so
+*.o
+*.a
+mkmf.log
+/.idea/
+.DS_STORE
+
+# Created by https://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## v0.3.0
+
+ - `public_visble` -> `privacy_level`
+ - `PrivacyLevel`s introduced
+ - added `User.authentication()` to get authentication options
+ - Gem is actually a Gem...

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cybercoach.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop', '~> 0.26', require: false
+end
+
+group :test do
+  gem 'rspec', '~> 3.1'
+  gem 'simplecov', '~> 0.9', require: false
+end
+
+group :development, :test do
+  gem 'pry', '~> 0.10'
+  gem 'pry-byebug', '~> 2.0'
+  gem 'pry-stack_explorer', '~> 0.4'
+end
+
+group :doc do
+  gem 'sdoc', '~> 0.4'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 NewYorkFalcons
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# CyberCoach
+
+Proxies the CyberCoach service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cybercoach'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cybercoach
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cybercoach/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cybercoach.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cybercoach/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cybercoach'
+  spec.version = CyberCoach::VERSION
+  spec.authors = ['Manuel Leuenberger']
+  spec.email = ['manuel.leu@students.unibe.ch']
+  spec.summary = 'CyberCoach proxy'
+  spec.description = 'Wraps the CyberCoach resources and their CRUD methods.'
+  spec.homepage = 'https://github.com/New-York-Falcons/cybercoach'
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/cybercoach/abstract_resource.rb

@@ -0,0 +1,162 @@
+module CyberCoach
+  #
+  # An AbstractResource can be read.
+  # Sets up serialization and deserialization using JSON.
+  #
+  class AbstractResource < Object
+    #
+    # Installs utilities to handle HTTP request and response.
+    # See {API doc}[http://www.rubydoc.info/github/jnunemaker/httparty] and
+    # {examples}[https://github.com/jnunemaker/httparty/tree/master/examples].
+    #
+    include HTTParty
+
+    #
+    # :private_attr: options
+    # The options that are always sent with each request, e.g. :basic_auth.
+    #
+
+    #
+    # The URI, the global identifier of it.
+    #
+    attr_accessor :uri
+
+    headers 'content-type' => 'application/json', 'accept' => 'application/json'
+    format :json
+    base_uri CyberCoach::Settings::SERVER_URI
+
+    #
+    # Creates an AbstractResource.
+    #
+    def initialize
+      super
+      @uri = nil
+      @options = {}
+    end
+
+    #
+    # :category: CRUD
+    #
+    # Reads it.
+    # 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.
+    #
+    def read(options = {})
+      invalidate_uri
+      invalidate_options
+      options = @options.merge(options)
+      response = self.class.get(@uri, options)
+      if response.success?
+        deserialize(response)
+      else
+        raise HttpError.new(response.response)
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a text based representations.
+    #
+    def serialize
+      format = self.class.default_options[:format]
+      if format.nil?
+        to_serializable
+      elsif format == :json
+        to_serializable.to_json
+      else
+        raise FormatNotSupportedError.new
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Deserializes it from a text based representation.
+    # serialization:: A text based representation.
+    #
+    def deserialize(serialization)
+      from_serializable(serialization)
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with the keys:
+    # * uri:: The URI.
+    #
+    def from_serializable(serializable)
+      @uri = serializable['uri']
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a serializable representation, which only contains simple data
+    # types.
+    # The hash has the keys:
+    # * uri:: The URI.
+    #
+    def to_serializable
+      serializable = {}
+      serializable['uri'] = @uri
+      serializable
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns the singular name of the resource.
+    # E.g. 'user' or 'entry'.
+    # This is used for parsing.
+    # Must be overridden in a subclass.
+    #
+    def singular_name
+      raise SubclassResponsibilityError.new
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns the plural name of the resource.
+    # E.g. 'users' or 'entries'.
+    # This is used for parsing.
+    # Must be overridden in a subclass.
+    #
+    def plural_name
+      raise SubclassResponsibilityError.new
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns the base URI relative to the server.
+    #
+    def resource_base_uri
+      "#{Settings::BASE_URI}/#{plural_name}/"
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Recalculates the URI from the attributes.
+    # A template method called before a request is made.
+    #
+    def invalidate_uri
+    end
+
+    #
+    # :category: Invalidation
+    #
+    # Recalculates the request options from the attributes.
+    # A template method called before a request is made.
+    #
+    def invalidate_options
+    end
+  end
+end

data/lib/cybercoach/entry.rb

@@ -0,0 +1,166 @@
+module CyberCoach
+  #
+  # An Entry is submitted to a Subscription to represent a finished activity of
+  # a specific duration at a specific location.
+  #
+  class Entry < Resource
+    #
+    # It is creatable by POST.
+    #
+    include PostCreateable
+
+    #
+    # :attr: subscription
+    # The Subscription it belongs to.
+    #
+
+    #
+    # :attr: comment
+    # A comment.
+    #
+
+    #
+    # :attr: location
+    # A description of the location.
+    #
+
+    #
+    # :attr: duration
+    # The duration.
+    # Nobody knows its unit (seconds/minutes).
+    #
+
+    #
+    # :attr: privacy_level
+    # The privacy level, see PrivacyLevel constants.
+    #
+
+    #
+    # :attr: date_created
+    # The date it was created.
+    #
+
+    #
+    # :attr: date_modified
+    # The date it was modified the last time.
+    #
+
+    attr_accessor :subscription,
+                  :comment,
+                  :location,
+                  :duration,
+                  :privacy_level,
+                  :date_created,
+                  :date_modified
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with a single key named like "entry#{@sport.name}" with another hash as value with the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * subscription:: A Subscription serializable.
+    # * comment:: A comment.
+    # * entrylocation:: A description of the location.
+    # * entryduration:: The duration. Nobody knows its unit (seconds/minutes).
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    # * datecreated:: The date it was created.
+    # * datemodified:: The date it was modified the last time.
+    #
+    def from_serializable(serializable)
+      # for some reason, the serializable is wrapped another level
+      serializable = serializable.values[0]
+      super(serializable)
+      @subscription = nil
+      unless serializable['subscription'].nil?
+        @subscription = Subscription.new
+        @subscription.from_serializable(serializable['subscription'])
+      end
+      @comment = serializable['comment']
+      @location = serializable['entrylocation']
+      @duration = serializable['entryduration']
+      @privacy_level = serializable['publicvisible']
+      @date_created = nil
+      unless serializable['datecreated'].nil?
+        @date_created = Time.at(serializable['datecreated']).to_datetime
+      end
+      @date_modified = nil
+      unless serializable['datemodified'].nil?
+        @date_modified = Time.at(serializable['datemodified']).to_datetime
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a serializable representation, which only contains simple data
+    # types.
+    # The hash has a single key named like "entry#{@sport.name}" with another hash as value with the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * comment:: A comment.
+    # * entrylocation:: A description of the location.
+    # * entryduration:: The duration. Nobody knows its unit (seconds/minutes).
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    #
+    def to_serializable
+      serializable = super
+      serializable['comment'] = @comment
+      serializable['entrylocation'] = @location
+      serializable['entryduration'] = @duration
+      serializable['publicvisible'] = @privacy_level
+      # cyber coach, you cunt!
+      sport = nil
+      if @id.nil?
+        sport = @subscription.uri.split('/')[-1].downcase
+      else
+        sport = @uri.split('/')[-2].downcase
+      end
+      {
+        "#{singular_name}#{sport}" => serializable
+      }
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'entry'.
+    #
+    def singular_name
+      'entry'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'entries'.
+    #
+    def plural_name
+      'entries'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Return the URI of its subscription.
+    #
+    def resource_base_uri
+      @subscription.uri
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the uri to the base uri and the id, if it is not nil.
+    #
+    def invalidate_uri
+      unless @id.nil?
+        @uri = "#{resource_base_uri}#{@id}/"
+      end
+    end
+  end
+end

data/lib/cybercoach/format_not_supported_error.rb

@@ -0,0 +1,7 @@
+module CyberCoach
+  #
+  # Raised when a format to parse from or encode to is not supported.
+  #
+  class FormatNotSupportedError < RuntimeError
+  end
+end

data/lib/cybercoach/http_error.rb

@@ -0,0 +1,27 @@
+module CyberCoach
+  #
+  # Raised when a response is unsuccessful.
+  #
+  class HttpError < RuntimeError
+    #
+    # The response that caused it.
+    #
+    attr_accessor :cause
+
+    #
+    # Creates a HttpError.
+    # cause:: The response that caused it.
+    #
+    def initialize(cause)
+      super
+      @cause = cause
+    end
+
+    #
+    # Returns a string representation including the cause's header and body.
+    #
+    def to_s
+      "#{super}\n\t#{@cause.to_hash}\n\t#{@cause.body}"
+    end
+  end
+end

data/lib/cybercoach/pageable.rb

@@ -0,0 +1,38 @@
+module CyberCoach
+  #
+  # Mixin to make a resource readable in pages.
+  # Include it in a class by to use it.
+  #
+  module Pageable
+    #
+    # 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
+      #
+      # :category: CRUD
+      #
+      # Returns the first page of resources.
+      # options:: A hash of options to send with the request.
+      #
+      def read_all(options = {})
+        page = ResourcePage.new(self)
+        page.read(options)
+        page
+      end
+    end
+
+    #
+    # The instance methods to install.
+    #
+    module InstanceMethods
+    end
+  end
+end