cronofy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7af5ec983510f03b2d3ef8361becea185d8a0d1
-  data.tar.gz: 13a2b60a3c2b377c80b8ad9f41b6587c41c8c57e
+  metadata.gz: bf3f22a7f76781d1e6ea8671f870cf5fd4b159a3
+  data.tar.gz: d4d4aea42bf0198af8af3bc7cab228eadf224c90
 SHA512:
-  metadata.gz: 7a7872c4415fba00b2797cc0ce953b4cbdf0a9b6b36b09a065ffa2660334f00002e8a127e02a70edee7259c63bb520b117e06a97de3a1c8583950e3c443b0f59
-  data.tar.gz: f1f5875132b96a55ad8d22e2a9816585ee2bbb1efef786314f1850592496c0ef7c07f57149b1ba7c45a67c354ea8ba94a1cae8aa4e097a9234c53eb412829f6c
+  metadata.gz: f495b40c4541fddd2a58eaa26371bed12bafa0760a332ff0c389a9fa8b7955526ab48fdd1081bd7097a566cd0f7bda5a103d95488711fa57edcadd1cee381657
+  data.tar.gz: 453719f98f0620ee3bc0d4f61fe1c61c19f09fa5f8362685f8e64d9d6f64f5feeb0a30075d0ff8f7b5d1889d1ac3d82925f08837cc06387ffe47b743a5e7734d

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+script: 'script/ci'
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby-head
+  - rbx-2
+  - ruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/9ca8d56f4d3a17425b18
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/README.md

@@ -1,5 +1,7 @@
 # Cronofy
 
+[![Build Status](https://travis-ci.org/cronofy/cronofy-ruby.svg?branch=master)](https://travis-ci.org/cronofy/cronofy-ruby)
+[![Gem Version](https://badge.fury.io/rb/cronofy.svg)](http://badge.fury.io/rb/cronofy)
 [![Join the chat at https://gitter.im/cronofy/cronofy-ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cronofy/cronofy-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [Cronofy](http://www.cronofy.com) - one API for all the calendars (Google, Outlook, iCloud, Exchange). This gem is an interface for easy use of [Cronofy API](http://www.cronofy.com/developers/api) with Ruby.
@@ -86,3 +88,7 @@ To delete an event from user's calendar:
 ```ruby
 cronofy.delete_event(calendar_id, event_id)
 ```
+
+## Links
+
+ * [API mailing list](https://groups.google.com/d/forum/cronofy-api)

data/lib/cronofy.rb

@@ -1,40 +1,114 @@
 require "cronofy/version"
 require "cronofy/auth"
 require "cronofy/response_parser"
+require "cronofy/errors"
 
 module Cronofy
   class Cronofy
 
-    def initialize(client_id, client_secret, token = false)
-      @auth = Auth.new(client_id, client_secret, token)
+    def initialize(client_id, client_secret, token=nil, refresh_token=nil)
+      @auth = Auth.new(client_id, client_secret, token, refresh_token)
     end
 
+    def access_token!
+      raise CredentialsMissingError.new unless @auth.access_token
+      @auth.access_token
+    end
+
+    # Public : Lists the calendars or the user across all of the calendar accounts
+    #          see http://www.cronofy.com/developers/api#calendars
+    #
+    # Returns Hash of calendars
     def list_calendars
-      ResponseParser.new(request(:get, 'calendars')).parse_json
+      response = do_request { access_token!.get("/v1/calendars")  }
+      ResponseParser.new(response).parse_json
     end
 
-    def create_or_update_event(calendar_id, event_data)
-      event_data[:start] = event_data[:start].utc.iso8601
-      event_data[:end] = event_data[:end].utc.iso8601
-      request(:post, "calendars/#{calendar_id}/events", event_data)
+    # Public : Creates or updates an existing event that matches the event_id, in the calendar
+    #          see: http://www.cronofy.com/developers/api#upsert-event
+    #          aliased as upsert_event
+    #
+    # calendar_id   - String Cronofy ID for the the calendar to contain the event
+    # event         - Hash describing the event with symbolized keys.
+    #                 :event_id String client identifier for event NOT Cronofy's
+    #                 :summary String
+    #                 :start Time
+    #                 :end Time
+    #
+    # Returns nothing
+    def create_or_update_event(calendar_id, event)
+      body = event.dup
+      body[:start] = event[:start].utc.iso8601
+      body[:end] = event[:end].utc.iso8601
+
+      headers = {
+        'Content-Type' => 'application/json'
+      }
+
+      do_request { access_token!.post("/v1/calendars/#{calendar_id}/events", { body: body.to_json, headers: headers }) }
     end
+    alias_method :upsert_event, :create_or_update_event
 
+    # Public : Deletes an event from the specified calendar
+    #          see http://www.cronofy.com/developers/api#delete-event
+    #
+    # calendar_id   - String Cronofy ID for the calendar containing the event
+    # event_id      - String client ID for the event
+    #
+    # Returns nothing
     def delete_event(calendar_id, event_id)
-      request(:delete, "calendars/#{calendar_id}/events", event_id: event_id)
+      params = { event_id: event_id }
+
+      do_request { access_token!.delete("/v1/calendars/#{calendar_id}/events", { params: params }) }
     end
 
-    def user_auth_link(redirect_uri)
-      @auth.user_auth_link(redirect_uri)
+    # Public : Generate the authorization URL to send the user to in order to generate
+    #          and authorization code in order for an access_token to be issued
+    #          see http://www.cronofy.com/developers/api#authorization
+    #
+    # redirect_uri  - String URI to return the user to once authorization process completed
+    # scope         - Array of scopes describing access required to the users calendars (default: all scopes)
+    #
+    # Returns String
+    def user_auth_link(redirect_uri, scope=nil)
+      @auth.user_auth_link(redirect_uri, scope)
     end
 
+    # Public : Returns the access_token for a given code and redirect_uri pair
+    #          see http://www.cronofy.com/developers/api#token-issue
+    #
+    # code          - String code returned to redirect_uri after authorization
+    # redirect_uri  - String URI returned to
+    #
+    # Returns Cronofy::Credentials
     def get_token_from_code(code, redirect_uri)
       @auth.get_token_from_code(code, redirect_uri)
     end
 
-    private
+    # Public : Refreshes the access_token and periodically the refresh_token for authorization
+    #          see http://www.cronofy.com/developers/api#token-refresh
+    #
+    # Returns Cronofy::Credentials
+    def refresh_access_token
+      @auth.refresh!
+    end
+
+  private
+
+    ERROR_MAP = {
+      401 => AuthorizationFailureError,
+      404 => NotFoundError,
+      422 => InvalidRequestError,
+      429 => TooManyRequestsError
+    }
 
-    def request(method, path, params = {})
-      @auth.request.send(method, "/v1/#{path}", params: params)
+    def do_request(&block)
+      begin
+        block.call
+      rescue OAuth2::Error => e
+        error_class = ERROR_MAP.fetch(e.response.status, UnknownError)
+        raise error_class.new(e.response.headers['status'], e.response)
+      end
     end
 
   end

data/lib/cronofy/auth.rb

@@ -2,28 +2,77 @@ require "oauth2"
 
 module Cronofy
   class Auth
-    API_URL = 'https://api.cronofy.com'
     APP_URL = 'https://app.cronofy.com'
+    API_URL = 'https://api.cronofy.com'
+
+    class Credentials
+
+      attr_reader :access_token,
+                  :expires_at,
+                  :expires_in,
+                  :refresh_token
 
-    def initialize(client_id, client_secret, token)
-      @client = OAuth2::Client.new(client_id, client_secret, site: API_URL)
-      @token = token
+      def initialize(oauth_token)
+        @access_token = oauth_token.token
+        @expires_at = oauth_token.expires_at
+        @expires_in = oauth_token.expires_in
+        @refresh_token = oauth_token.refresh_token
+      end
+
+      def to_hash
+        {
+          access_token: access_token,
+          refresh_token: refresh_token,
+          expires_in: expires_in,
+          expires_at: expires_at
+        }
+      end
     end
 
-    def user_auth_link(redirect_uri)
-      url = @client.auth_code.authorize_url(
-        :redirect_uri => redirect_uri,
-        :response_type => 'code'
-      ).gsub(API_URL, APP_URL)
-      "#{url}&scope=list_calendars read_events create_event delete_event"
+    attr_reader :access_token
+
+    def initialize(client_id, client_secret, token=nil, refresh_token=nil)
+      @auth_client = OAuth2::Client.new(client_id, client_secret, site: APP_URL)
+      @api_client = OAuth2::Client.new(client_id, client_secret, site: API_URL)
+
+      set_access_token(token, refresh_token) if token
+    end
+
+    # Public: generate a URL for authorizing the application with Cronofy
+    #
+    # redirect_uri    String, the URI to return to after authorization
+    # scope           Array of String, the scope requested
+    #                 Default: [read_account, list_calendars, read_events, create_event, delete_event]
+    #                 see: http://www.cronofy.com/developers/api#authorization
+    #
+    # Returns String URL
+    def user_auth_link(redirect_uri, scope=nil)
+      scope ||= %w{read_account list_calendars read_events create_event delete_event}
+
+      @auth_client.auth_code.authorize_url(:redirect_uri => redirect_uri, :response_type => 'code', :scope => scope.join(' '))
     end
 
     def get_token_from_code(code, redirect_uri)
-      @client.auth_code.get_token(code, :redirect_uri => redirect_uri).token
+      auth_token = @auth_client.auth_code.get_token(code, :redirect_uri => redirect_uri)
+      set_access_token_from_auth_token(auth_token)
+      Credentials.new(@access_token)
+    end
+
+    # Public: Refreshes the access token
+    # Returns Hash of token elements to allow client to update in local store for user
+    def refresh!
+      auth_token = access_token.refresh!
+      set_access_token_from_auth_token(auth_token)
+      Credentials.new(@access_token)
     end
 
-    def request
-      @request ||= OAuth2::AccessToken.new(@client, @token)
+    def set_access_token_from_auth_token(auth_token)
+      set_access_token(auth_token.token, auth_token.refresh_token)
     end
+
+    def set_access_token(token, refresh_token)
+      @access_token = OAuth2::AccessToken.new(@api_client, token, { refresh_token: refresh_token })
+    end
+
   end
 end

data/lib/cronofy/errors.rb

@@ -0,0 +1,55 @@
+module Cronofy
+  class CronofyError < StandardError
+
+  end
+
+  class CredentialsMissingError < CronofyError
+
+    def initialize(message=nil)
+      super(message || "No credentials supplied")
+    end
+
+  end
+
+  class APIError < CronofyError
+    attr_reader :response
+
+    def initialize(message, response=nil)
+      super(message)
+      @response = response
+    end
+
+    def body
+      response.body if response
+    end
+
+    def headers
+      response.headers if response
+    end
+
+    def inspect
+      "<#{self.class.name} message=#{message} headers=#{headers.inspect} body=#{body}>"
+    end
+  end
+
+  class NotFoundError < APIError
+
+  end
+
+  class AuthorizationFailureError < APIError
+
+  end
+
+  class InvalidRequestError < APIError
+
+  end
+
+  class TooManyRequestsError < APIError
+
+  end
+
+  class UnknownError < APIError
+
+  end
+
+end

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/script/ci

@@ -0,0 +1,7 @@
+#! /bin/bash
+
+# Fail fast
+set -o errexit
+
+bundle install
+bundle exec rake spec

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sergii Paryzhskyi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: 
@@ -73,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,8 +82,10 @@ files:
 - cronofy.gemspec
 - lib/cronofy.rb
 - lib/cronofy/auth.rb
+- lib/cronofy/errors.rb
 - lib/cronofy/response_parser.rb
 - lib/cronofy/version.rb
+- script/ci
 - spec/response_parser_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cronofy/cronofy-ruby
@@ -95,17 +98,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars