cronofy 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da5d96380934904435706ec98e7aa923abd05cc7
-  data.tar.gz: 73720046c2544252bdec8d7f7d5d5af8d7b93f2a
+  metadata.gz: 1be096b17b4eb2b3422337a2d168b7f27559493c
+  data.tar.gz: e696a6175e17d0465912d7810342cfd1352b7191
 SHA512:
-  metadata.gz: 884b2c8194a158011ee7f4c03218e1f28f75bab6c904d6e36b39ef7734a58082e6601a8ccbc6a02359c5cdbbc1e0d46a3c865ebb33934018b3e0d24a75fcd87c
-  data.tar.gz: 96feb5c06ccad53deb93df2fc819fb4182857615776e7713484e45e230626c2f885258448941c912ed21296fed61ec69225808a4be741b3677dc7c92d63605fb
+  metadata.gz: 5ea577cd0076d2aa66cdf8c7ecd6791aa1d80ef216a51535d51a46b351b586ef7fcb4456ce8cb4be78c010f8bcf82f6b12239f82d2948131324c6ae746696f9b
+  data.tar.gz: 0071814777c83e679d6b704595b756c6aa709c4540430fff18a2b29caefcbbeca8309390931259fd9b5c5159fb1e82c34920e2f9c65aebe11ee6490919223d74

data/README.md

@@ -24,9 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
-You have to register on cronofy website and create an application there. You will get a client id and client secret which you will have to pass to initializer. You can also pass a token that you will get later, or leave it blank in case if you don't have it now:
+You have to register on cronofy website and create an application there. You will get a client id and client secret which you will have to pass to initializer. You can also pass a token and refresh token that you will get later, or leave it blank in case if you don't have it now:
 ```ruby
-cronofy = Cronofy.new('CLIENT_ID', 'CLIENT_SECRET', 'TOKEN')
+cronofy = Cronofy::Client.new('CLIENT_ID', 'CLIENT_SECRET', 'TOKEN', 'REFRESH_TOKEN')
 ```
 
 Generate a link for a user to grant access for his calendars:
@@ -81,7 +81,7 @@ event_data = {
     description: "Meeting room"
   }
 }
-cronofy.create_or_update_event(calendar_id, event_data)
+cronofy.upsert(calendar_id, event_data)
 ```
 
 To delete an event from user's calendar:
@@ -91,4 +91,6 @@ cronofy.delete_event(calendar_id, event_id)
 
 ## Links
 
+ * [API Docs](http://www.cronofy.com/developers/api)
  * [API mailing list](https://groups.google.com/d/forum/cronofy-api)
+

data/lib/cronofy.rb

@@ -1,118 +1,26 @@
 require "cronofy/version"
+require "cronofy/errors"
 require "cronofy/auth"
+require "cronofy/client"
 require "cronofy/response_parser"
-require "cronofy/errors"
 require 'json'
 
 module Cronofy
-  class Cronofy
-
-    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
-      response = do_request { access_token!.get("/v1/calendars")  }
-      ResponseParser.new(response).parse_json
-    end
-
-    # 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: JSON.generate(body), 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)
-      params = { event_id: event_id }
-
-      do_request { access_token!.delete("/v1/calendars/#{calendar_id}/events", { params: params }) }
-    end
-
-    # 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
-
-    # 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
+  def self.api_url
+    @api_url ||= (ENV['CRONOFY_API_URL'] || "https://api.cronofy.com")
+  end
 
-    ERROR_MAP = {
-      401 => AuthenticationFailureError,
-      403 => AuthorizationFailureError,
-      404 => NotFoundError,
-      422 => InvalidRequestError,
-      429 => TooManyRequestsError
-    }
+  def self.api_url=(value)
+    @api_url = value
+  end
 
-    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
+  def self.app_url
+    @app_url ||= (ENV['CRONOFY_APP_URL'] || "https://app.cronofy.com")
+  end
 
+  def self.app_url=(value)
+    @app_url = value
   end
 
 end

data/lib/cronofy/auth.rb

@@ -2,9 +2,6 @@ require "oauth2"
 
 module Cronofy
   class Auth
-    APP_URL = 'https://app.cronofy.com'
-    API_URL = 'https://api.cronofy.com'
-
     class Credentials
 
       attr_reader :access_token,
@@ -32,8 +29,8 @@ module Cronofy
     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)
+      @auth_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.app_url)
+      @api_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.api_url)
 
       set_access_token(token, refresh_token) if token
     end

data/lib/cronofy/client.rb

@@ -0,0 +1,119 @@
+module Cronofy
+
+  class Client
+
+    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
+      response = do_request { access_token!.get("/v1/calendars")  }
+      ResponseParser.new(response).parse_json
+    end
+
+    # 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: JSON.generate(body), 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)
+      params = { event_id: event_id }
+
+      do_request { access_token!.delete("/v1/calendars/#{calendar_id}/events", { params: params }) }
+    end
+
+    # 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
+
+    # 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 => ::Cronofy::AuthenticationFailureError,
+      403 => ::Cronofy::AuthorizationFailureError,
+      404 => ::Cronofy::NotFoundError,
+      422 => ::Cronofy::InvalidRequestError,
+      429 => ::Cronofy::TooManyRequestsError
+    }
+
+    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
+
+  # Alias for backwards compatibility
+  # depcrectated will be removed
+  class Cronofy < Client
+
+  end
+
+end

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Sergii Paryzhskyi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - cronofy.gemspec
 - lib/cronofy.rb
 - lib/cronofy/auth.rb
+- lib/cronofy/client.rb
 - lib/cronofy/errors.rb
 - lib/cronofy/response_parser.rb
 - lib/cronofy/version.rb