asana 0.0.6 → 0.1.1

data/Rakefile

@@ -1,10 +1,65 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
 
-Rake::TestTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new do |t|
+  t.stats_options = ['--list-undoc']
+end
+
+desc 'Generates a test resource from a YAML using the resource template.'
+task :codegen do
+  `node spec/support/codegen.js`
+end
+
+namespace :bump do
+  def read_version
+    File.readlines('./lib/asana/version.rb')
+      .detect { |l| l =~ /VERSION/ }
+      .scan(/VERSION = '([^']+)/).flatten.first.split('.')
+      .map { |n| Integer(n) }
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def write_version(major, minor, patch)
+    str = <<-EOS
+#:nodoc:
+module Asana
+  # Public: Version of the gem.
+  VERSION = '#{major}.#{minor}.#{patch}'
+end
+EOS
+    File.open('./lib/asana/version.rb', 'w') do |f|
+      f.write str
+    end
+
+    new_version = "#{major}.#{minor}.#{patch}"
+    system('git add lib/asana/version.rb')
+    system(%(git commit -m "Bumped to #{new_version}" && ) +
+           %(git tag -a v#{new_version} -m "Version #{new_version}"))
+    puts "\nRun git push --tags to release."
+  end
+
+  desc 'Bumps a patch version'
+  task :patch do
+    major, minor, patch = read_version
+    write_version major, minor, patch + 1
+  end
+
+  desc 'Bumps a minor version'
+  task :minor do
+    major, minor, = read_version
+    write_version major, minor + 1, 0
+  end
+
+  desc 'Bumps a major version'
+  task :major do
+    major, = read_version
+    write_version major + 1, 0, 0
+  end
 end
 
-desc "Run tests"
-task :default => :test
+task default: [:codegen, :spec, :rubocop, :yard]

data/asana.gemspec

@@ -1,26 +1,32 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/asana/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asana/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Ryan Bright"]
-  gem.email         = ["ryan@rbright.net"]
-  gem.description   = %q{Ruby wrapper for the Asana REST API}
-  gem.summary       = %q{Ruby wrapper for the Asana REST API}
-  gem.homepage      = "http://github.com/rbright/asana"
-  gem.license       = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name          = "asana"
+  spec.version       = Asana::VERSION
+  spec.authors       = ["Txus"]
+  spec.email         = ["me@txus.io"]
 
-  gem.add_dependency 'activeresource', '>= 3.2.3'
+  spec.summary       = %q{Official Ruby client for the Asana API}
+  spec.description   = %q{Official Ruby client for the Asana API}
+  spec.homepage      = "https://github.com/asana/ruby-asana"
+  spec.license       = "MIT"
 
-  gem.add_development_dependency 'guard-minitest', '~> 1.0.0'
-  gem.add_development_dependency 'minitest', '~> 2.12.1'
-  gem.add_development_dependency 'rake', '~> 0.9.2.2'
-  gem.add_development_dependency 'vcr', '~> 2.1.0'
-  gem.add_development_dependency 'webmock', '~> 1.8.6'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "asana"
-  gem.require_paths = ["lib"]
-  gem.version       = Asana::VERSION
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "oauth2", "~> 1.0"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "faraday_middleware-multi_json", "~> 0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
 end

data/examples/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'omniauth'
+gem 'omniauth-asana'
+gem 'sinatra'
+gem 'ruby-asana', path: '../'

data/examples/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: ../
+  specs:
+    ruby-asana (0.1.0)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      faraday_middleware-multi_json (~> 0.0)
+      oauth2 (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    faraday_middleware-multi_json (0.0.6)
+      faraday_middleware
+      multi_json
+    hashie (3.4.1)
+    jwt (1.5.0)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.2.2)
+      hashie (>= 1.2, < 4)
+      rack (~> 1.0)
+    omniauth-asana (0.0.1)
+      omniauth (~> 1.0)
+      omniauth-oauth2 (~> 1.1)
+    omniauth-oauth2 (1.3.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (1.6.1)
+    rack-protection (1.5.3)
+      rack
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth
+  omniauth-asana
+  ruby-asana!
+  sinatra

data/examples/api_token.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler.require
+require 'asana'
+
+api_token = ENV['ASANA_API_TOKEN']
+unless api_token
+  abort "Run this program with the env var ASANA_API_TOKEN.\n"  \
+    "Go to http://app.asana.com/-/account_api to see your API token."
+end
+
+client = Asana::Client.new do |c|
+  c.authentication :api_token, api_token
+end
+
+puts "My Workspaces:"
+client.workspaces.find_all.each do |workspace|
+  puts "\t* #{workspace.name} - tags:"
+  client.tags.find_by_workspace(workspace: workspace.id).each do |tag|
+    puts "\t\t- #{tag.name}"
+  end
+end

data/examples/cli_app.rb

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler.require
+require 'asana'
+
+id, secret = ENV['ASANA_CLIENT_ID'], ENV['ASANA_CLIENT_SECRET']
+unless id && secret
+  abort "Run this program with the env vars ASANA_CLIENT_ID and ASANA_CLIENT_SECRET.\n"  \
+    "Refer to https://asana.com/developers/documentation/getting-started/authentication "\
+    "to get your credentials." \
+    "The redirect URI for your application should be \"urn:ietf:wg:oauth:2.0:oob\"."
+end
+
+access_token = Asana::Authentication::OAuth2.offline_flow(client_id: id,
+                                                          client_secret: secret)
+client = Asana::Client.new do |c|
+  c.authentication :oauth2, access_token
+end
+
+puts "My Workspaces:"
+client.workspaces.find_all.each do |workspace|
+  puts "\t* #{workspace.name} - tags:"
+  client.tags.find_by_workspace(workspace: workspace.id).each do |tag|
+    puts "\t\t- #{tag.name}"
+  end
+end

data/examples/events.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require 'bundler'
+Bundler.require
+require 'asana'
+
+api_token = ENV['ASANA_API_TOKEN']
+unless api_token
+  abort "Run this program with the env var ASANA_API_TOKEN.\n"  \
+    "Go to http://app.asana.com/-/account_api to see your API token."
+end
+
+client = Asana::Client.new do |c|
+  c.authentication :api_token, api_token
+end
+
+workspace = client.workspaces.find_all.first
+task = client.tasks.find_all(assignee: "me", workspace: workspace.id).first
+unless task
+  task = client.tasks.create(workspace: workspace.id, name: "Hello world!", assignee: "me")
+end
+
+Thread.abort_on_exception = true
+
+Thread.new do
+  puts "Listening for 'changed' events on #{task} in one thread..."
+  task.events(wait: 2).lazy.select { |event| event.action == 'changed' }.each do |event|
+    puts "#{event.user.name} changed #{event.resource}"
+  end
+end
+
+Thread.new do
+  puts "Listening for non-'changed' events on #{task} in another thread..."
+  task.events(wait: 1).lazy.reject { |event| event.action == 'changed' }.each do |event|
+    puts "'#{event.action}' event: #{event}"
+  end
+end
+
+sleep

data/examples/omniauth_integration.rb

@@ -0,0 +1,54 @@
+require 'bundler'
+Bundler.require
+require 'asana'
+
+class SinatraApp < Sinatra::Base
+  id, secret = ENV['ASANA_CLIENT_ID'], ENV['ASANA_CLIENT_SECRET']
+  unless id && secret
+    abort "Run this program with the env vars ASANA_CLIENT_ID and ASANA_CLIENT_SECRET.\n"  \
+      "Refer to https://asana.com/developers/documentation/getting-started/authentication "\
+      "to get your credentials."
+  end
+
+  use OmniAuth::Strategies::Asana, id, secret
+
+  enable :sessions
+
+  get '/' do
+    if $client
+      '<a href="/workspaces">My Workspaces</a>'
+    else
+      '<a href="/sign_in">sign in to asana</a>'
+    end
+  end
+
+  get '/workspaces' do
+    if $client
+      "<h1>My Workspaces</h1>" \
+        "<ul>" + $client.workspaces.find_all.map { |w| "<li>#{w.name}</li>" }.join + "</ul>"
+    else
+      redirect '/sign_in'
+    end
+  end
+
+  get '/auth/:name/callback' do
+    creds = request.env["omniauth.auth"]["credentials"].tap { |h| h.delete('expires') }
+    strategy = request.env["omniauth.strategy"]
+    access_token = OAuth2::AccessToken.from_hash(strategy.client, creds).refresh!
+    $client = Asana::Client.new do |c|
+      c.authentication :oauth2, access_token
+    end
+    redirect '/workspaces'
+  end
+
+  get '/sign_in' do
+    redirect '/auth/asana'
+  end
+
+  get '/sign_out' do
+    $client = nil
+    redirect '/'
+  end
+end
+
+SinatraApp.run! if __FILE__ == $0

data/lib/asana.rb

@@ -1,15 +1,12 @@
-require 'active_resource'
-
-require 'asana/config'
+require 'asana/ruby2_0_0_compatibility'
+require 'asana/authentication'
+require 'asana/resources'
+require 'asana/client'
+require 'asana/errors'
+require 'asana/http_client'
 require 'asana/version'
 
-require 'asana/resources/project'
-require 'asana/resources/tag'
-require 'asana/resources/story'
-require 'asana/resources/task'
-require 'asana/resources/user'
-require 'asana/resources/workspace'
-
+# Public: Top-level namespace of the Asana API Ruby client.
 module Asana
-  extend Config
+  include Asana::Resources
 end

data/lib/asana/authentication.rb

@@ -0,0 +1,8 @@
+require_relative 'authentication/oauth2'
+require_relative 'authentication/token_authentication'
+
+module Asana
+  # Public: Authentication strategies for the Asana API.
+  module Authentication
+  end
+end

data/lib/asana/authentication/oauth2.rb

@@ -0,0 +1,42 @@
+require_relative 'oauth2/bearer_token_authentication'
+require_relative 'oauth2/access_token_authentication'
+require_relative 'oauth2/client'
+
+module Asana
+  module Authentication
+    # Public: Deals with OAuth2 authentication. Contains a function to get an
+    # access token throught a browserless authentication flow, needed for some
+    # applications such as CLI applications.
+    module OAuth2
+      module_function
+
+      # Public: Retrieves an access token through an offline authentication
+      # flow. If your application can receive HTTP requests, you might want to
+      # opt for a browser-based flow and use the omniauth-asana gem instead.
+      #
+      # Your registered application's redirect_uri should be exactly
+      # "urn:ietf:wg:oauth:2.0:oob".
+      #
+      # client_id     - [String] the client id of the registered Asana API
+      #                 application.
+      # client_secret - [String] the client secret of the registered Asana API
+      #                 application.
+      #
+      # Returns an ::OAuth2::AccessToken object.
+      #
+      # Note: This function reads from STDIN and writes to STDOUT. It is meant
+      # to be used only within the context of a CLI application.
+      def offline_flow(client_id: required('client_id'),
+                       client_secret: required('client_secret'))
+        client = Client.new(client_id: client_id,
+                            client_secret: client_secret,
+                            redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
+        STDOUT.puts '1. Go to the following URL to authorize the ' \
+          " application: #{client.authorize_url}"
+        STDOUT.puts '2. Paste the authorization code here: '
+        auth_code = STDIN.gets.chomp
+        client.token_from_auth_code(auth_code)
+      end
+    end
+  end
+end

data/lib/asana/authentication/oauth2/access_token_authentication.rb

@@ -0,0 +1,51 @@
+module Asana
+  module Authentication
+    module OAuth2
+      # Public: A mechanism to authenticate with an OAuth2 access token (a
+      # bearer token and a refresh token) or just a refresh token.
+      class AccessTokenAuthentication
+        # Public: Builds an AccessTokenAuthentication from a refresh token and
+        # client credentials, by refreshing into a new one.
+        #
+        # refresh_token - [String] a refresh token
+        # client_id     - [String] the client id of the registered Asana API
+        #                 Application.
+        # client_secret - [String] the client secret of the registered Asana API
+        #                 Application.
+        # redirect_uri  - [String] the redirect uri of the registered Asana API
+        #                 Application.
+        #
+        # Returns an [AccessTokenAuthentication] instance with a refreshed
+        # access token.
+        def self.from_refresh_token(refresh_token,
+                                    client_id: required('client_id'),
+                                    client_secret: required('client_secret'),
+                                    redirect_uri: required('redirect_uri'))
+          client = Client.new(client_id: client_id,
+                              client_secret: client_secret,
+                              redirect_uri: redirect_uri)
+          new(client.token_from_refresh_token(refresh_token))
+        end
+
+        # Public: Initializes a new AccessTokenAuthentication.
+        #
+        # access_token - [::OAuth2::AccessToken] An ::OAuth2::AccessToken
+        #                object.
+        def initialize(access_token)
+          @token = access_token
+        end
+
+        # Public: Configures a Faraday connection injecting a bearer token,
+        # auto-refreshing it when needed.
+        #
+        # connection - [Faraday::Connection] the Faraday connection instance.
+        #
+        # Returns nothing.
+        def configure(connection)
+          @token = @token.refresh! if @token.expired?
+          connection.request :oauth2, @token.token
+        end
+      end
+    end
+  end
+end