todoist 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4 @@
1
+ == 0.0.1 2008-06-25
2
+
3
+ * 1 major enhancement:
4
+ * Initial release
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2008 Jonathan Stott
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,30 @@
1
+ History.txt
2
+ License.txt
3
+ Manifest.txt
4
+ README.txt
5
+ Rakefile
6
+ config/hoe.rb
7
+ config/requirements.rb
8
+ lib/todoist.rb
9
+ lib/todoist/connection.rb
10
+ lib/todoist/errors.rb
11
+ lib/todoist/version.rb
12
+ script/console
13
+ script/destroy
14
+ script/generate
15
+ script/txt2html
16
+ setup.rb
17
+ spec/spec.opts
18
+ spec/spec_helper.rb
19
+ spec/todoist_spec.rb
20
+ tasks/deployment.rake
21
+ tasks/environment.rake
22
+ tasks/rspec.rake
23
+ tasks/website.rake
24
+ test/test_helper.rb
25
+ test/test_todoist.rb
26
+ website/index.html
27
+ website/index.txt
28
+ website/javascripts/rounded_corners_lite.inc.js
29
+ website/stylesheets/screen.css
30
+ website/template.html.erb
@@ -0,0 +1,55 @@
1
+ = todoist
2
+
3
+ * todoist.rubyforge.com
4
+
5
+ == DESCRIPTION:
6
+
7
+ A gem to provide a simple API for interacting with the todoist.com task manager
8
+ website. This should not be confused with the previous todoist gem released by
9
+ the same author and then removed.
10
+
11
+ It should soon function a lot better, and with a much saner interface, and
12
+ without the need to explicitly pass collections around and such.
13
+
14
+ == FEATURES/PROBLEMS:
15
+
16
+ * FIX (list of features or problems)
17
+
18
+ == SYNOPSIS:
19
+
20
+ FIX (code sample of usage)
21
+
22
+ == REQUIREMENTS:
23
+
24
+ * json gem
25
+
26
+ == INSTALL:
27
+
28
+ Very simple
29
+
30
+ sudo gem install todoist
31
+
32
+ == LICENSE:
33
+
34
+ (The MIT License)
35
+
36
+ Copyright (c) 2008 Jonathan Stott
37
+
38
+ Permission is hereby granted, free of charge, to any person obtaining
39
+ a copy of this software and associated documentation files (the
40
+ 'Software'), to deal in the Software without restriction, including
41
+ without limitation the rights to use, copy, modify, merge, publish,
42
+ distribute, sublicense, and/or sell copies of the Software, and to
43
+ permit persons to whom the Software is furnished to do so, subject to
44
+ the following conditions:
45
+
46
+ The above copyright notice and this permission notice shall be
47
+ included in all copies or substantial portions of the Software.
48
+
49
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
50
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
51
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
52
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
53
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
54
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
55
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,4 @@
1
+ require 'config/requirements'
2
+ require 'config/hoe' # setup Hoe + all gem configuration
3
+
4
+ Dir['tasks/**/*.rake'].each { |rake| load rake }
@@ -0,0 +1,73 @@
1
+ require 'todoist/version'
2
+
3
+ AUTHOR = 'Jonathan Stott' # can also be an array of Authors
4
+ EMAIL = "jonathan.stott@gmail.com"
5
+ DESCRIPTION = "A gem which provides an interface for interacting with the todoist.com service."
6
+ GEM_NAME = 'todoist' # what ppl will type to install your gem
7
+ RUBYFORGE_PROJECT = 'todoist' # The unix name for your project
8
+ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
9
+ DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
10
+ EXTRA_DEPENDENCIES = [
11
+ ['json', '>= 1.1.2']
12
+ ] # An array of rubygem dependencies [name, version]
13
+
14
+ @config_file = "~/.rubyforge/user-config.yml"
15
+ @config = nil
16
+ RUBYFORGE_USERNAME = "unknown"
17
+ def rubyforge_username
18
+ unless @config
19
+ begin
20
+ @config = YAML.load(File.read(File.expand_path(@config_file)))
21
+ rescue
22
+ puts <<-EOS
23
+ ERROR: No rubyforge config file found: #{@config_file}
24
+ Run 'rubyforge setup' to prepare your env for access to Rubyforge
25
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
26
+ EOS
27
+ exit
28
+ end
29
+ end
30
+ RUBYFORGE_USERNAME.replace @config["username"]
31
+ end
32
+
33
+
34
+ REV = nil
35
+ # UNCOMMENT IF REQUIRED:
36
+ # REV = YAML.load(`svn info`)['Revision']
37
+ VERS = Todoist::VERSION::STRING + (REV ? ".#{REV}" : "")
38
+ RDOC_OPTS = ['--quiet', '--title', 'todoist documentation',
39
+ "--opname", "index.html",
40
+ "--line-numbers",
41
+ "--main", "README.rdoc",
42
+ "--inline-source"]
43
+
44
+ class Hoe
45
+ def extra_deps
46
+ @extra_deps.reject! { |x| Array(x).first == 'hoe' }
47
+ @extra_deps
48
+ end
49
+ end
50
+
51
+ # Generate all the Rake tasks
52
+ # Run 'rake -T' to see list of generated tasks (from gem root directory)
53
+ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
54
+ p.developer(AUTHOR, EMAIL)
55
+ p.description = DESCRIPTION
56
+ p.summary = DESCRIPTION
57
+ p.url = HOMEPATH
58
+ p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
59
+ p.test_globs = ["test/**/test_*.rb"]
60
+ p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store'] #An array of file patterns to delete on clean.
61
+
62
+ # == Optional
63
+ p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
64
+ p.extra_deps = EXTRA_DEPENDENCIES
65
+
66
+ #p.spec_extras = {} # A hash of extra values to set in the gemspec.
67
+ end
68
+
69
+ CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
70
+ PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
71
+ $hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
72
+ $hoe.rsync_args = '-av --delete --ignore-errors'
73
+ $hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""
@@ -0,0 +1,15 @@
1
+ require 'fileutils'
2
+ include FileUtils
3
+
4
+ require 'rubygems'
5
+ %w[rake hoe newgem rubigen].each do |req_gem|
6
+ begin
7
+ require req_gem
8
+ rescue LoadError
9
+ puts "This Rakefile requires the '#{req_gem}' RubyGem."
10
+ puts "Installation: gem install #{req_gem} -y"
11
+ exit
12
+ end
13
+ end
14
+
15
+ $:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
@@ -0,0 +1,20 @@
1
+ $:.unshift(File.dirname(__FILE__)) unless
2
+ $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
3
+
4
+ module Todoist
5
+
6
+ end
7
+
8
+ begin
9
+ require 'json'
10
+ rescue LoadError
11
+ require 'rubygems'
12
+ require 'json'
13
+ end
14
+
15
+ require 'cgi'
16
+ require 'net/http'
17
+ require 'net/https'
18
+ require 'todoist/errors'
19
+ require 'todoist/connection'
20
+ require 'todoist/project'
@@ -0,0 +1,109 @@
1
+
2
+ module Todoist
3
+ ##
4
+ # It is the connection module's responsibility to make all requests to the
5
+ # todoist API, and to deserialize the response into a Hash. Before any
6
+ # requests are made to the todoist service, the connection information should
7
+ # be provided via the setup method.
8
+ module Connection
9
+
10
+ @@url_base = 'todoist.com'
11
+ @@api_base = '/API'
12
+ @@is_set_up = false
13
+
14
+ ##
15
+ #
16
+ # This method should be called before all others to initialize the
17
+ # variables needed for any API requests, the API key and if the account is
18
+ # premium or not. No actual request is made at this stage.
19
+ #
20
+ # @param [String] api_key The todoist API key, findable in your preferences
21
+ # @param [Boolean] premium Is the account premium? If set to true, API
22
+ # requests are made via https. Not required and
23
+ # defaults to false.
24
+ #
25
+ def self.setup(api_key, premium = false)
26
+ @@is_set_up = true
27
+ @@api_key = api_key
28
+ @@premium = premium
29
+ end
30
+
31
+ ##
32
+ #
33
+ # Instantiates and makes a query to the given API method with the provided
34
+ # request keys.
35
+ #
36
+ # The response is parsed from the JSON to native ruby objects as appropriate
37
+ #
38
+ # @param [String] api_method The API method to call. Must be supplied.
39
+ # @param [Hash] keys An array of keys to be included in the URL.
40
+ # This shouldn't include the token
41
+ #
42
+ # @return [Hash] The response, parsed from the JSON
43
+ #
44
+ # @raise [NotSetupError] The connection has not been set up
45
+ # @raise [TokenNotCorrect] The server returned a message indicating a bad
46
+ # token was sent
47
+ # @raise [InvalidAPICall] The request was made to an invalid API address
48
+ # @raise [BadResponse] The server didn't return a 200 (and wasn't a bad
49
+ # token or a 404)
50
+ #
51
+ def self.api_request(api_method, keys={})
52
+ raise(NotSetupError, "Call Todoist::Connection.setup before making any API requests") unless @@is_set_up
53
+
54
+ # first, construct our URL string
55
+ request = construct_request_string(api_method, keys)
56
+
57
+ # next, make our request
58
+ response = make_api_request(request)
59
+
60
+ return JSON.parse(response)
61
+ end
62
+
63
+ protected
64
+
65
+ # constructs a request string from the method and the keys passed in, adding
66
+ # the token
67
+ def self.construct_request_string(api_method, keys={})
68
+ # convert our hash of keys into an appropriate array.
69
+ urlized_keys = jsonized_url_array(keys)
70
+ urlized_keys.unshift "token=#{@@api_key}"
71
+
72
+ return "#{@@api_base}/#{api_method}?#{urlized_keys.join('&')}"
73
+ end
74
+
75
+ # converts the keys to a JSONized array, and CGI escapes them
76
+ def self.jsonized_url_array(keys={})
77
+ array = keys.inject([]) do |array, h|
78
+ jsonized = h[1].to_json
79
+ escaped = CGI.escape(jsonized)
80
+ array << "#{h[0]}=#{escaped}"
81
+ end
82
+ return array
83
+ end
84
+
85
+ # makes a request from the todoist API
86
+ def self.make_api_request(request)
87
+ port = (@@premium) ? 443 : 80
88
+ http = Net::HTTP.new(@@url_base, port)
89
+ http.use_ssl = @@premium
90
+
91
+ new_request = Net::HTTP::Get.new(request)
92
+
93
+ # actually make our request!
94
+ response = http.request(new_request)
95
+
96
+ if response.code == '200'
97
+ return response.body
98
+ else
99
+ if response.code == '404'
100
+ raise InvalidAPICall
101
+ elsif response.code == '500' && response.body =~ /Token not correct!/
102
+ raise TokenNotCorrect
103
+ else
104
+ raise(BadResponse,"#{response.code} - #{response.body})")
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,6 @@
1
+ module Todoist
2
+ class NotSetupError < Exception;end
3
+ class TokenNotCorrect < Exception;end
4
+ class InvalidAPICall < Exception;end
5
+ class BadResponse < Exception;end
6
+ end
@@ -0,0 +1,9 @@
1
+ module Todoist
2
+ module VERSION #:nodoc:
3
+ MAJOR = 0
4
+ MINOR = 0
5
+ TINY = 1
6
+
7
+ STRING = [MAJOR, MINOR, TINY].join('.')
8
+ end
9
+ end
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env ruby
2
+ # File: script/console
3
+ irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
4
+
5
+ libs = " -r irb/completion"
6
+ # Perhaps use a console_lib to store any extra methods I may want available in the cosole
7
+ # libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
8
+ libs << " -r #{File.dirname(__FILE__) + '/../lib/todoist.rb'}"
9
+ puts "Loading todoist gem"
10
+ exec "#{irb} #{libs} --simple-prompt"
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+ APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
3
+
4
+ begin
5
+ require 'rubigen'
6
+ rescue LoadError
7
+ require 'rubygems'
8
+ require 'rubigen'
9
+ end
10
+ require 'rubigen/scripts/destroy'
11
+
12
+ ARGV.shift if ['--help', '-h'].include?(ARGV[0])
13
+ RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
14
+ RubiGen::Scripts::Destroy.new.run(ARGV)
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+ APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
3
+
4
+ begin
5
+ require 'rubigen'
6
+ rescue LoadError
7
+ require 'rubygems'
8
+ require 'rubigen'
9
+ end
10
+ require 'rubigen/scripts/generate'
11
+
12
+ ARGV.shift if ['--help', '-h'].include?(ARGV[0])
13
+ RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
14
+ RubiGen::Scripts::Generate.new.run(ARGV)
@@ -0,0 +1,82 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ GEM_NAME = 'todoist' # what ppl will type to install your gem
4
+ RUBYFORGE_PROJECT = 'todoist'
5
+
6
+ require 'rubygems'
7
+ begin
8
+ require 'newgem'
9
+ require 'rubyforge'
10
+ rescue LoadError
11
+ puts "\n\nGenerating the website requires the newgem RubyGem"
12
+ puts "Install: gem install newgem\n\n"
13
+ exit(1)
14
+ end
15
+ require 'redcloth'
16
+ require 'syntax/convertors/html'
17
+ require 'erb'
18
+ require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
19
+
20
+ version = Todoist::VERSION::STRING
21
+ download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
22
+
23
+ def rubyforge_project_id
24
+ RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
25
+ end
26
+
27
+ class Fixnum
28
+ def ordinal
29
+ # teens
30
+ return 'th' if (10..19).include?(self % 100)
31
+ # others
32
+ case self % 10
33
+ when 1: return 'st'
34
+ when 2: return 'nd'
35
+ when 3: return 'rd'
36
+ else return 'th'
37
+ end
38
+ end
39
+ end
40
+
41
+ class Time
42
+ def pretty
43
+ return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
44
+ end
45
+ end
46
+
47
+ def convert_syntax(syntax, source)
48
+ return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
49
+ end
50
+
51
+ if ARGV.length >= 1
52
+ src, template = ARGV
53
+ template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
54
+ else
55
+ puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
56
+ exit!
57
+ end
58
+
59
+ template = ERB.new(File.open(template).read)
60
+
61
+ title = nil
62
+ body = nil
63
+ File.open(src) do |fsrc|
64
+ title_text = fsrc.readline
65
+ body_text_template = fsrc.read
66
+ body_text = ERB.new(body_text_template).result(binding)
67
+ syntax_items = []
68
+ body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
69
+ ident = syntax_items.length
70
+ element, syntax, source = $1, $2, $3
71
+ syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
72
+ "syntax-temp-#{ident}"
73
+ }
74
+ title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
75
+ body = RedCloth.new(body_text).to_html
76
+ body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
77
+ end
78
+ stat = File.stat(src)
79
+ created = stat.ctime
80
+ modified = stat.mtime
81
+
82
+ $stdout << template.result(binding)