whenhub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0f343e2acd32d7e7eb9f0a38786ad1cc58f5c80
+  data.tar.gz: f56a305ec39851f53e67125d04f44c0c3cef0493
+SHA512:
+  metadata.gz: cf12852146574cb66eb29e4817a0538aadd6a296b5e23541aced46d13b7770697b03a1b88b49175210311c59dbf194542d5fa8a31c11c5949e8e0d83c8906274
+  data.tar.gz: 4deb730636fa9967524a2c75ebd155b310cba9111043472d3b0e7c20f17f21b463c231ea4da0b4ebc31f7ffc7fb356a442c466e5aec06bd8161026cd28f65b32

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in whenhub.gemspec
+gemspec

data/README.md

@@ -0,0 +1,122 @@
+# WhenHub
+
+This is a gem for interacting with [the WhenHub API](https://developer.whenhub.com/).
+
+> WhenHub lets you transform time-ordered information such as a timeline or schedule into a beautiful, interactive, embeddable Whencast that entertains, educates, and provides chronological context.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whenhub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whenhub
+
+## Usage
+
+The best guide for using this gem is the script in `bin/test`, which exercises all of the supported endpoints and prints the method outputs.
+You can use this script as a guide for invoking the gem, and you can run it against your live WhenHub account by running:
+
+```
+RESTCLIENT_LOG=stdout bundle exec bin/test [YOUR ACCESS TOKEN]
+```
+
+The gem uses a client model to query against the API. You create and configure a client with your access token.
+(Note: You can find your access token by visiting your [WhenHub account page](https://studio.whenhub.com/account).)
+
+```
+require 'whenhub'
+
+client = WhenHub::Client.new(access_token: YOUR_ACCESS_TOKEN)
+```
+
+After creating the client you're able to make requests to any of the WhenHub APIs.
+Some examples follow below.
+
+### [My User Information](https://developer.whenhub.com/v1.0/reference#users-me)
+
+```
+user = client.me
+```
+
+### [My Schedules](https://developer.whenhub.com/v1.0/reference#usersmeschedules)
+
+```
+schedules = client.schedules.all
+```
+
+### [Schedule with Events](https://developer.whenhub.com/v1.0/reference#usersmeschedulesscheduleidfilterincludeevents)
+
+```
+schedule = client.schedules.find(schedule_id)
+```
+
+### [Schedules with Events & Media](https://developer.whenhub.com/v1.0/reference#schedule-with-events-and-media)
+
+```
+schedule = client.schedules.find(schedule_id, media: true)
+```
+
+### [Create a new schedule](https://developer.whenhub.com/v1.0/reference#create-a-new-schedule)
+
+```
+schedule = client.schedules.create
+```
+
+### [Create a new event](https://developer.whenhub.com/v1.0/reference#create-a-new-event)
+
+```
+event = schedule.events.create
+```
+
+### [Update an event](https://developer.whenhub.com/v1.0/reference#update-an-event)
+
+```
+event.name = 'My Event'
+event.save
+```
+
+### [Remove an event](https://developer.whenhub.com/v1.0/reference#remove-an-event)
+
+```
+event.delete
+```
+
+### [Delete Multiple Events](https://developer.whenhub.com/v1.0/reference#delete-multiple-events)
+
+```
+schedule.events.delete(event_ids)
+```
+
+### [Add an image to a Schedule](https://developer.whenhub.com/v1.0/reference#add-an-image-to-a-schedule)
+
+```
+schedule.upload_image(url)
+```
+
+### [Add an image to an Event](https://developer.whenhub.com/v1.0/reference#add-an-image-to-an-event)
+
+```
+event.upload_image(url)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whenhub.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whenhub"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require 'whenhub'
+
+client = WhenHub.client(access_token: ARGV.last)
+
+puts 'client.me'
+p client.me
+puts
+puts '------------'
+puts
+
+puts 'client.schedules.all'
+schedules = client.schedules.all
+p schedules
+puts
+puts '------------'
+puts
+
+puts 'client.schedules.find(schedule_id)'
+schedule_id = schedules.first.id
+schedule = client.schedules.find(schedule_id)
+p schedule
+puts
+puts '------------'
+puts
+
+puts 'client.schedules.find(schedule_id, media: true)'
+schedule = client.schedules.find(schedule_id, media: true)
+p schedule
+puts
+puts '------------'
+puts
+
+schedule = client.schedules.create(
+  name: 'Hello World',
+  description: 'Here is a test schedule I am trying to create',
+  scope: 'private'
+)
+p schedule
+puts
+puts '------------'
+puts
+
+puts 'schedule.events.create'
+event = schedule.events.create(
+  name: 'Cool Event',
+  description: 'Look at it go',
+  when: {
+    "period" => "minute",
+    "startDate" => "2017-05-07T22:00:00-04:00",
+    "endDate" => nil,
+    "startTimezone" => "America/New_York",
+    "endTimezone" => nil
+  }
+)
+p event
+puts
+puts '------------'
+puts
+
+puts 'schedule.events.all'
+p schedule.events.all
+puts
+puts '------------'
+puts
+
+puts 'event.delete'
+p event.delete
+puts
+puts '------------'
+puts
+
+client.schedules.all.each do |schedule|
+  p schedule.delete if schedule.name == 'Hello World'
+end
+
+__END__
+
+TODO:
+schedule.events.delete(event_ids)
+schedule.upload_image(url)
+event.upload_image(url)

data/lib/whenhub.rb

@@ -0,0 +1,8 @@
+require 'whenhub/version'
+require 'whenhub/client'
+
+module WhenHub
+  def self.client(access_token:)
+    WhenHub::Client.new(access_token: access_token)
+  end
+end

data/lib/whenhub/client.rb

@@ -0,0 +1,44 @@
+require 'whenhub/user'
+require 'whenhub/schedules_collection'
+require 'whenhub/schedule'
+require 'whenhub/events_collection'
+require 'whenhub/event'
+
+require 'rest-client'
+require 'json'
+
+module WhenHub
+  class Client
+    RESOURCE = RestClient::Resource.new('https://api.whenhub.com')
+
+    def initialize(access_token:)
+      @access_token = access_token
+    end
+
+    def me
+      User.build(self, get('/api/users/me'))
+    end
+
+    def schedules
+      SchedulesCollection.new(self)
+    end
+
+    def get(path, params={})
+      JSON.parse(nested_resource(path).get(params: params))
+    end
+
+    def post(path, params={})
+      JSON.parse(nested_resource(path).post(params))
+    end
+
+    def delete(path)
+      JSON.parse(nested_resource(path).delete)
+    end
+
+    private
+
+    def nested_resource(path)
+      RESOURCE[path + "?access_token=#{@access_token}"]
+    end
+  end
+end

data/lib/whenhub/event.rb

@@ -0,0 +1,55 @@
+require 'virtus'
+
+module WhenHub
+  class Event
+    include Virtus.model
+
+    attribute :when, Hash
+    attribute :name, String
+    attribute :description, String
+    attribute :icon, String
+    attribute :location, Hash
+    attribute :resources, Array
+    attribute :priority, String
+    attribute :draft, Boolean
+    attribute :tags, Array
+    attribute :order, Integer
+    attribute :customFieldData, Hash
+    attribute :id, String
+    attribute :userId, String
+    attribute :createdAt, Time
+    attribute :updatedAt, Time
+    attribute :createdBy, String
+    attribute :updatedBy, String
+    attribute :scheduleId, String
+
+    attr_accessor :client
+
+    def self.build(client, schedule, attributes)
+      new(attributes).tap do |event|
+        event.client = client
+        event.scheduleId = schedule.id
+      end
+    end
+
+    def save
+      self.attributes = @client.post(
+        "/api/users/me/schedules/#{scheduleId}/events",
+        writeable_attributes
+      ).first
+    end
+
+    def writeable_attributes
+      {
+        when: self.when,
+        name: name,
+        description: description,
+        scheduleId: scheduleId
+      }
+    end
+
+    def delete
+      @client.delete("/api/events/#{id}")
+    end
+  end
+end

data/lib/whenhub/events_collection.rb

@@ -0,0 +1,22 @@
+module WhenHub
+  class EventsCollection
+    def initialize(client, schedule)
+      @client = client
+      @schedule = schedule
+    end
+
+    def all
+      @client.get("/api/users/me/schedules/#{@schedule.id}/events").map do |attributes|
+        Event.build(@client, @schedule, attributes)
+      end
+    end
+
+    def build(attributes = {})
+      Event.build(@client, @schedule, attributes)
+    end
+
+    def create(attributes = {})
+      build(attributes).tap(&:save)
+    end
+  end
+end

data/lib/whenhub/schedule.rb

@@ -0,0 +1,52 @@
+require 'virtus'
+
+module WhenHub
+  class Schedule
+    include Virtus.model
+
+    attribute :calendar, Hash
+    attribute :name, String
+    attribute :description, String
+    attribute :curator, String
+    attribute :scope, String
+    attribute :viewCode, String
+    attribute :tags, Array
+    attribute :id, String
+    attribute :userId, String
+    attribute :createdAt, Time
+    attribute :updatedAt, Time
+    attribute :createdBy, String
+    attribute :updatedBy, String
+
+    attr_accessor :client
+
+    def self.build(client, attributes)
+      new(attributes).tap do |schedule|
+        schedule.client = client
+      end
+    end
+
+    def save
+      self.attributes = @client.post(
+        '/api/users/me/schedules',
+        writeable_attributes
+      )
+    end
+
+    def writeable_attributes
+      {
+        name: name,
+        description: description,
+        scope: scope
+      }
+    end
+
+    def delete
+      @client.delete("/api/schedules/#{id}")
+    end
+
+    def events
+      EventsCollection.new(client, self)
+    end
+  end
+end

data/lib/whenhub/schedules_collection.rb

@@ -0,0 +1,31 @@
+module WhenHub
+  class SchedulesCollection
+    def initialize(client)
+      @client = client
+    end
+
+    def all
+      @client.get('/api/users/me/schedules').map do |attributes|
+        Schedule.build(@client, attributes)
+      end
+    end
+
+    def find(schedule_id, media: false)
+      params = {
+        'filter[include][events]' => ['media'],
+        'filter[include]' => ['media']
+      }
+
+      attributes = @client.get("/api/users/me/schedules/#{schedule_id}", params)
+      Schedule.build(@client, attributes)
+    end
+
+    def build(attributes = {})
+      Schedule.build(@client, attributes)
+    end
+
+    def create(attributes = {})
+      build(attributes).tap(&:save)
+    end
+  end
+end

data/lib/whenhub/user.rb

@@ -0,0 +1,25 @@
+require 'virtus'
+
+module WhenHub
+  class User
+    include Virtus.model
+
+    attribute :displayName, String
+    attribute :photo, String
+    attribute :login, Time
+    attribute :twoFactor, Boolean
+    attribute :username, String
+    attribute :id, String
+    attribute :createdAt, Time
+    attribute :updatedAt, Time
+    attribute :schedulesFollowed, Array
+
+    attr_accessor :client
+
+    def self.build(client, attributes)
+      new(attributes).tap do |schedule|
+        schedule.client = client
+      end
+    end
+  end
+end

data/lib/whenhub/version.rb

@@ -0,0 +1,3 @@
+module WhenHub
+  VERSION = "0.1.0"
+end

data/whenhub.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whenhub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whenhub"
+  spec.version       = WhenHub::VERSION
+  spec.authors       = ["Matt Gillooly"]
+  spec.email         = ["git@mattgillooly.com"]
+
+  spec.description   = %q{a gem for the WhenHub API}
+  spec.summary       = spec.description
+  spec.homepage      = 'http://github.com/mattgillooly/whenhub'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'virtus'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: whenhub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Gillooly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: a gem for the WhenHub API
+email:
+- git@mattgillooly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- lib/whenhub.rb
+- lib/whenhub/client.rb
+- lib/whenhub/event.rb
+- lib/whenhub/events_collection.rb
+- lib/whenhub/schedule.rb
+- lib/whenhub/schedules_collection.rb
+- lib/whenhub/user.rb
+- lib/whenhub/version.rb
+- whenhub.gemspec
+homepage: http://github.com/mattgillooly/whenhub
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: a gem for the WhenHub API
+test_files: []