timekit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a949e4226d697c9097cb9b375019fe09de090c6e
+  data.tar.gz: af28a8f0b4cef1cf9de19eee1d03b06f76a44d7e
+SHA512:
+  metadata.gz: 50ba7321a6251f3703446ec428530b2f7898901dac50b7c9ba0619c2ac206fc5a85e4d3a82afe8e2f83443c6023faf9fa6fa7b00c9f9b2fcb39516d26e438e51
+  data.tar.gz: 48a5d03e9c6f8a0d72483bd4303299b51c5059a0fe3e1497e811e3877e33cbda00e80e522322abd61d9fde1a73f4decab80baf4fe7024b247ea190824f9f8c5e

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.0.1
+-----
+* [Initial release]

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project. Here are some ways *you* can contribute:
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace).
+* Refactor code.
+* Fix [issues][].
+* Review patches.
+
+[issues]: https://github.com/mgauthier/timekit/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016-2016 Michael Gauthier
+
+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,359 @@
+# The Timekit Ruby Gem
+
+[![Gem Version](http://img.shields.io/gem/v/timekit.svg)][gem]
+
+[gem]: https://rubygems.org/gems/timekit
+
+A Ruby interface to the Timekit API.
+
+## Installation
+    gem install timekit
+
+## Configuration
+Configure the Timekit client before using it
+
+```ruby
+Timekit.configure({
+  app       : 'your-app-name',
+  email     : 'user@example.com',
+  api_token : 'your-api-token'
+})
+```
+
+## Documentation
+[http://developers.timekit.io/docs]
+
+## Usage Examples
+After configuring Timekit you can initialize a `client`,
+and then you can do the following.
+
+### Apps
+
+**Initialize your client**
+```ruby
+client = Timekit.app_client
+```
+
+**List**
+```ruby
+client.list
+```
+
+**Create**
+```ruby
+client.create('app-name')
+```
+
+**Update**
+```ruby
+client.update('app-slug')
+```
+
+**Delete**
+```ruby
+client.delete('app-slug')
+```
+
+### Bookings
+
+**Initialize your client**
+```ruby
+client = Timekit.booking_client
+```
+
+**List**
+```ruby
+client.list
+```
+
+**Show**
+```ruby
+client.show('booking-id')
+```
+
+**Create**
+```ruby
+client.create(
+  'booking-graph-type', # 'confirm-decline'
+  {
+    start: 'start-date',
+    end: 'end-date',
+    what: 'booking-title',
+    where: 'booking-address',
+    calendar_id: 'replace-with-id',
+    description: 'booking-description'
+  },
+  {
+    name: 'booking-customer-name',
+    email: 'booking-customer-email',
+    phone: 'booking-customer-phone',
+    voip: 'booking-customer-voip',
+    timezone: 'booking-timezone'
+  },
+  'booking-action', # 'create'
+}
+```
+
+**Update**
+```ruby
+client.update('booking-id', 'confirm')
+```
+
+### Calendars
+
+**Initialize your client**
+
+```ruby
+client = Timekit.calendar_client
+```
+
+**List**
+```ruby
+client.list
+```
+
+**Show**
+```ruby
+client.show('calendar-id')
+```
+
+**Create**
+```ruby
+client.create(
+  'calendar-name',
+  'calendar-description',
+  'calendar-backgroundcolor',
+  'calendar-foregroundcolor'
+}
+```
+
+**Update**
+Not yet implemented
+
+**Delete**
+```ruby
+client.delete('calendar-id')
+```
+
+
+### Credentials
+
+**Initialize your client**
+
+```ruby
+client = Timekit.credential_client
+```
+
+**List**
+```ruby
+client.list
+```
+
+**Create**
+```ruby
+client.create(
+  'credential-type',
+  'credential-scope',
+  'credential-description',
+  'credential-referrer',
+  'credential-expires',
+)
+```
+
+**Delete**
+```ruby
+client.delete('credential-id')
+```
+
+### Events
+
+**Initialize your client**
+
+```ruby
+client = Timekit.event_client
+```
+
+**List**
+```ruby
+client.list(
+  'start-time',
+  'end-time'
+)
+```
+
+**Show**
+```ruby
+client.show('event-id')
+```
+
+**Create**
+```ruby
+client.create(
+  'event-start',
+  'event-end',
+  'what',
+  'where',
+  'calendar_id',
+  'participants',
+  'invite',
+  'description',
+  'sync_provider',
+  'my_rsvp',
+  'all_day'
+)
+```
+
+**Update**
+
+```ruby
+client.update(
+  'event-id',
+  'event-start',
+  'event-end',
+  'what',
+  'where',
+  'participants',
+  'all_day'
+)
+```
+
+**Delete**
+```ruby
+client.delete('event-id')
+```
+
+### Findtime
+
+**Initialize your client**
+
+```ruby
+client = Timekit.findtime_client
+```
+
+### User
+
+**Initialize your client**
+
+```ruby
+client = Timekit.user_client
+```
+
+**Me**
+```ruby
+client.me
+```
+
+**Timezone**
+```ruby
+client.timezone('user-email')
+```
+
+**Update**
+
+```ruby
+client.update(
+  'user-first_name',
+  'user-last_name',
+  'user-timezone',
+  'user-password'
+)
+```
+
+**Reset Password**
+```ruby
+client.reset_password('user-email')
+```
+
+### Widget
+
+**Initialize your client**
+
+```ruby
+client = Timekit.widget_client
+```
+
+**List**
+```ruby
+client.list
+```
+
+**Embed**
+```ruby
+client.embed('widget-id')
+```
+
+**Hosted**
+```ruby
+client.hosted('widget-id')
+```
+
+**Create**
+
+```ruby
+client.create(
+  'widget-config',
+  'widget-name',
+  'widget-slug',
+)
+```
+
+
+**Update**
+
+```ruby
+client.update(
+  'widget-id',
+  'widget-config',
+  'widget-name',
+  'widget-slug',
+)
+```
+
+**Delete**
+```ruby
+client.delete('widget-id')
+```
+
+
+## Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+versions:
+
+* Ruby 2.0.0
+* Ruby 2.1
+* Ruby 2.2
+* JRuby 9.1.1.0
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+## Versioning
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+    spec.add_dependency 'timekit', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+
+## Copyright
+Copyright (c) 20016-2016 Michael Gauthier
+See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/lib/timekit/app/client.rb

@@ -0,0 +1,32 @@
+module Timekit
+  class App
+    # Client class for the app resource
+    class Client < Timekit::Client
+      API_PATH = '/apps'.freeze
+
+      def list
+        get(API_PATH)
+      end
+
+      def create(name, settings = {})
+        params = {
+          name: name
+        }
+
+        params[:settings] = settings if settings
+
+        post(API_PATH, params)
+      end
+
+      def update(slug, settings)
+        params = settings
+
+        put(API_PATH + '/' + slug, params)
+      end
+
+      def delete(slug)
+        super(API_PATH + '/' + slug)
+      end
+    end
+  end
+end

data/lib/timekit/app.rb

@@ -0,0 +1,6 @@
+require_relative './app/client'
+
+module Timekit
+  class App
+  end
+end

data/lib/timekit/authorization.rb

@@ -0,0 +1,17 @@
+module Timekit
+  class Authorization
+    attr_reader :email, :api_token
+
+    def initialize(email, api_token)
+      @email = email
+      @api_token = api_token
+    end
+
+    def as_json
+      {
+        email: @email,
+        api_token: @api_token
+      }
+    end
+  end
+end

data/lib/timekit/booking/client.rb

@@ -0,0 +1,40 @@
+module Timekit
+  class Booking
+    # Client class for the booking resource
+    class Client < Timekit::Client
+      API_PATH = '/bookings'.freeze
+
+      def list
+        get(API_PATH)
+      end
+
+      def show(id)
+        get(API_PATH + '/' + id)
+      end
+
+      def create(
+        graph,
+        event,
+        customer,
+        action = nil
+      )
+        params = {
+          graph: graph,
+          event: event,
+          customer: customer
+        }
+
+        params[:action] = action if action
+
+        post(API_PATH, params)
+      end
+
+      def update(
+        id,
+        action
+      )
+        put(API_PATH + '/' + id + '/' + action)
+      end
+    end
+  end
+end

data/lib/timekit/booking.rb

@@ -0,0 +1,6 @@
+require_relative './booking/client'
+
+module Timekit
+  class Booking
+  end
+end

data/lib/timekit/calendar/client.rb

@@ -0,0 +1,37 @@
+module Timekit
+  class Calendar
+    # Client class for the calendar resource
+    class Client < Timekit::Client
+      API_PATH = '/calendars'.freeze
+
+      def create(
+        name,
+        description,
+        background_color = nil,
+        foreground_color = nil
+      )
+        params = {
+          name: name,
+          description: description
+        }
+
+        params[:backgroundcolor] = background_color if background_color
+        params[:foregroundcolor] = foreground_color if foreground_color
+
+        post(API_PATH, params)
+      end
+
+      def list
+        get(API_PATH)
+      end
+
+      def show(id)
+        get(API_PATH + '/' + id.to_s)
+      end
+
+      def delete(id)
+        super(API_PATH + '/' + id.to_s)
+      end
+    end
+  end
+end

data/lib/timekit/calendar.rb

@@ -0,0 +1,6 @@
+require_relative './calendar/client'
+
+module Timekit
+  class Calendar
+  end
+end

data/lib/timekit/client.rb

@@ -0,0 +1,45 @@
+require 'base64'
+
+module Timekit
+  class Client
+    def initialize(app = nil, authorization = nil)
+      @app = app || Timekit.config[:app]
+      @authorization = authorization || Timekit.config[:credentials]
+
+      raise 'No app configured' if @app.nil?
+      raise 'No authorization configured' if @authorization.nil?
+    end
+
+    protected
+
+    #
+    # Wrapper method for the timekit request methods of the same names
+    #
+    [:get, :put, :post, :delete].each do |verb|
+      define_method(verb) do |path, params = {}|
+        # puts "Timekit::Client::#{verb} => #{path}#{token}"
+        headers = {
+          'Timekit-App' => @app,
+          'Authorization' => http_basic_auth_header
+        }
+
+        Timekit::Request.instance.send(
+          __method__,
+          path,
+          params,
+          headers
+        )
+      end
+    end
+
+    private
+
+    def http_basic_auth_header
+      encoded = Base64.strict_encode64(
+        "#{@authorization.email}:#{@authorization.api_token}"
+      )
+
+      "Basic #{encoded}"
+    end
+  end
+end

data/lib/timekit/config.rb

@@ -0,0 +1,16 @@
+module Timekit
+  class Config < Hash
+    CONFIG_KEYS = [
+      :credentials,
+      :app
+    ].freeze
+
+    def []=(key, value)
+      raise 'Invalid config key' unless CONFIG_KEYS.include?(key)
+      raise 'Invalid config credentials' if key == :credentials &&
+                                            !value.is_a?(Timekit::Authorization)
+
+      super(key, value)
+    end
+  end
+end

data/lib/timekit/credential/client.rb

@@ -0,0 +1,35 @@
+module Timekit
+  class Credential
+    # Client class for the credential resource
+    class Client < Timekit::Client
+      API_PATH = '/credentials'.freeze
+
+      def list
+        get(API_PATH)
+      end
+
+      def create(
+        type, # 'client-token' or 'server-token'
+        scopes, # 'global' or 'widget'
+        description,
+        referrer = nil,
+        expires = nil # default 1 year from now (timestamp)
+      )
+        params = {
+          type: type,
+          scopes: scopes,
+          description: description
+        }
+
+        params[:referrer] = referrer if referrer
+        params[:expires] = expires if expires
+
+        post(API_PATH, params)
+      end
+
+      def delete(id)
+        super(API_PATH + '/' + id.to_s)
+      end
+    end
+  end
+end

data/lib/timekit/credential.rb

@@ -0,0 +1,6 @@
+require_relative './credential/client'
+
+module Timekit
+  class Credential
+  end
+end