pipedrive_ruby 1.0.1.pre15
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.codeclimate.yml +30 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.rubocop.yml +1156 -0
- data/.travis.yml +8 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +4 -0
- data/Guardfile +56 -0
- data/LICENSE.txt +21 -0
- data/README.md +59 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Activities.html +138 -0
- data/doc/ActivitiesFields.html +134 -0
- data/doc/ActivitiesTypes.html +141 -0
- data/doc/Authorizations.html +138 -0
- data/doc/Currencies.html +143 -0
- data/doc/DealsFields.html +146 -0
- data/doc/EmailMessages.html +137 -0
- data/doc/EmailThreads.html +136 -0
- data/doc/Estages.html +137 -0
- data/doc/Files.html +139 -0
- data/doc/Filters.html +139 -0
- data/doc/GlobalMessages.html +134 -0
- data/doc/Goals.html +137 -0
- data/doc/NoteFields.html +134 -0
- data/doc/Notes.html +137 -0
- data/doc/OrganizationFields.html +147 -0
- data/doc/OrganizationRelationships.html +135 -0
- data/doc/PermissionSets.html +134 -0
- data/doc/PersonFields.html +146 -0
- data/doc/Persons.html +136 -0
- data/doc/PipedriveRuby/Activities.html +159 -0
- data/doc/PipedriveRuby/ActivitiesFields.html +148 -0
- data/doc/PipedriveRuby/ActivitiesTypes.html +148 -0
- data/doc/PipedriveRuby/ActivityFields.html +148 -0
- data/doc/PipedriveRuby/ActivityTypes.html +148 -0
- data/doc/PipedriveRuby/Authorizations.html +231 -0
- data/doc/PipedriveRuby/Base.html +456 -0
- data/doc/PipedriveRuby/Currencies.html +162 -0
- data/doc/PipedriveRuby/DealFields.html +148 -0
- data/doc/PipedriveRuby/Deals.html +842 -0
- data/doc/PipedriveRuby/HttpFactory.html +1362 -0
- data/doc/PipedriveRuby/Organizations.html +148 -0
- data/doc/PipedriveRuby/PipedriveClient.html +385 -0
- data/doc/PipedriveRuby/Products.html +319 -0
- data/doc/PipedriveRuby/PushNotifications.html +159 -0
- data/doc/PipedriveRuby/Recents.html +159 -0
- data/doc/PipedriveRuby/SearchResults.html +250 -0
- data/doc/PipedriveRuby/UserConnections.html +159 -0
- data/doc/PipedriveRuby/UserSettings.html +159 -0
- data/doc/PipedriveRuby.html +174 -0
- data/doc/Pipelines.html +134 -0
- data/doc/ProductFields.html +147 -0
- data/doc/Products.html +140 -0
- data/doc/PushNotifications.html +141 -0
- data/doc/Recent.html +134 -0
- data/doc/Roles.html +134 -0
- data/doc/SearchResults.html +135 -0
- data/doc/UserConnections.html +134 -0
- data/doc/UserSettings.html +134 -0
- data/doc/Users.html +137 -0
- data/doc/_index.html +425 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +474 -0
- data/doc/file.README.html +160 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +160 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +411 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/http_factory.rb +154 -0
- data/lib/pipedrive_client.rb +24 -0
- data/lib/pipedrive_ruby/version.rb +4 -0
- data/lib/pipedrive_ruby.rb +48 -0
- data/lib/resources/activities.rb +9 -0
- data/lib/resources/activitiy_fields.rb +6 -0
- data/lib/resources/activity_types.rb +11 -0
- data/lib/resources/authorizations.rb +16 -0
- data/lib/resources/base.rb +17 -0
- data/lib/resources/currencies.rb +13 -0
- data/lib/resources/deal_fields.rb +10 -0
- data/lib/resources/deals.rb +72 -0
- data/lib/resources/email_messages.rb +5 -0
- data/lib/resources/email_threads.rb +4 -0
- data/lib/resources/files.rb +4 -0
- data/lib/resources/filters.rb +4 -0
- data/lib/resources/global_messages.rb +3 -0
- data/lib/resources/goals.rb +4 -0
- data/lib/resources/note_fields.rb +3 -0
- data/lib/resources/notes.rb +4 -0
- data/lib/resources/organization_fields.rb +8 -0
- data/lib/resources/organization_relationships.rb +3 -0
- data/lib/resources/organizations.rb +7 -0
- data/lib/resources/permission_sets.rb +3 -0
- data/lib/resources/person_fields.rb +3 -0
- data/lib/resources/persons.rb +4 -0
- data/lib/resources/pipelines.rb +3 -0
- data/lib/resources/product_fields.rb +8 -0
- data/lib/resources/products.rb +29 -0
- data/lib/resources/push_notifications.rb +10 -0
- data/lib/resources/recents.rb +6 -0
- data/lib/resources/roles.rb +3 -0
- data/lib/resources/search_results.rb +14 -0
- data/lib/resources/stages.rb +4 -0
- data/lib/resources/user_connections.rb +7 -0
- data/lib/resources/user_settings.rb +6 -0
- data/lib/resources/users.rb +5 -0
- data/pipedrive_ruby.gemspec +34 -0
- metadata +286 -0
@@ -0,0 +1,160 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.0
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<iframe id="search_frame" src="file_list.html"></iframe>
|
61
|
+
|
62
|
+
<div id="content"><div id='filecontents'>
|
63
|
+
<h1 id="label-PipedriveRuby">PipedriveRuby</h1>
|
64
|
+
|
65
|
+
<p><a
|
66
|
+
href="https://codeclimate.com/github/lypborges/pipedrive_ruby/coverage"><img
|
67
|
+
src="https://travis-ci.org/lypborges/pipedrive_ruby.svg?branch=master}[https://travis-ci.org/lypborges/pipedrive_ruby]<a href="rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg" target="_parent" title="rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg">rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg</a>[https://codeclimate.com/github/lypborges/pipedrive_ruby]{rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/coverage.svg"></a></p>
|
68
|
+
|
69
|
+
<p>It's a working in progress.</p>
|
70
|
+
|
71
|
+
<h2 id="label-Tested+with+Ruby+versions-3A">Tested with Ruby versions:</h2>
|
72
|
+
<ul><li>
|
73
|
+
<p>2.0.0</p>
|
74
|
+
</li><li>
|
75
|
+
<p>2.1.9</p>
|
76
|
+
</li><li>
|
77
|
+
<p>2.2.5</p>
|
78
|
+
</li><li>
|
79
|
+
<p>2.3.1</p>
|
80
|
+
</li></ul>
|
81
|
+
|
82
|
+
<p>Welcome to your new gem! To experiment with that code, run
|
83
|
+
<code>bin/console</code> for an interactive prompt.</p>
|
84
|
+
|
85
|
+
<h2 id="label-Installation">Installation</h2>
|
86
|
+
|
87
|
+
<p>Add this line to your application's Gemfile:</p>
|
88
|
+
|
89
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pipedrive_ruby</span><span class='tstring_end'>'</span></span>
|
90
|
+
</code></pre>
|
91
|
+
|
92
|
+
<p>And then execute:</p>
|
93
|
+
|
94
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
95
|
+
|
96
|
+
<p>Or install it yourself as:</p>
|
97
|
+
|
98
|
+
<pre class="code ruby"><code class="ruby">$ gem install pipedrive_ruby --pre</code></pre>
|
99
|
+
|
100
|
+
<h2 id="label-Usage">Usage</h2>
|
101
|
+
|
102
|
+
<p>See Wiki <a href="https://github.com/lypborges/pipedrive_ruby/wiki">getting
|
103
|
+
started!</a></p>
|
104
|
+
|
105
|
+
<h2 id="label-Development">Development</h2>
|
106
|
+
|
107
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
108
|
+
dependencies. Then, run <code>rake spec</code> to run the tests. You can
|
109
|
+
also run <code>bin/console</code> for an interactive prompt that will allow
|
110
|
+
you to experiment.</p>
|
111
|
+
|
112
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
113
|
+
install</code>. To release a new version, update the version number in
|
114
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
115
|
+
release</code>, which will create a git tag for the version, push git
|
116
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
117
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
118
|
+
|
119
|
+
<h2 id="label-Contributing">Contributing</h2>
|
120
|
+
|
121
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
122
|
+
href="https://github.com/lypborges/pipedrive_ruby">github.com/lypborges/pipedrive_ruby</a>.
|
123
|
+
This project is intended to be a safe, welcoming space for collaboration,
|
124
|
+
and contributors are expected to adhere to the <a
|
125
|
+
href="http://contributor-covenant.org">Contributor Covenant</a> code of
|
126
|
+
conduct.</p>
|
127
|
+
|
128
|
+
<h2 id="label-Publishing+new+version+with">Publishing new version with</h2>
|
129
|
+
<ul><li>
|
130
|
+
<p>Using <a
|
131
|
+
href="https://github.com/svenfuchs/gem-release">github.com/svenfuchs/gem-release</a></p>
|
132
|
+
</li><li>
|
133
|
+
<p><code>gem install gem-release</code> if you don't have.</p>
|
134
|
+
</li><li>
|
135
|
+
<p><code>gem bump --version pre</code>, this will change the version according</p>
|
136
|
+
</li><li>
|
137
|
+
<p><code>gem release --tag</code> this will, publish to rubygems.org and tag
|
138
|
+
on github</p>
|
139
|
+
</li></ul>
|
140
|
+
|
141
|
+
<h2 id="label-Tips">Tips</h2>
|
142
|
+
|
143
|
+
<p>before push/pull requests always run tests: - <code>codeclimate
|
144
|
+
analyze</code> - <code>spec</code></p>
|
145
|
+
|
146
|
+
<h2 id="label-License">License</h2>
|
147
|
+
|
148
|
+
<p>The gem is available as open source under the terms of the <a
|
149
|
+
href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
150
|
+
</div></div>
|
151
|
+
|
152
|
+
<div id="footer">
|
153
|
+
Generated on Tue Jul 19 12:47:24 2016 by
|
154
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
155
|
+
0.9.0 (ruby-2.2.5).
|
156
|
+
</div>
|
157
|
+
|
158
|
+
</div>
|
159
|
+
</body>
|
160
|
+
</html>
|
data/doc/file_list.html
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<title>File List</title>
|
19
|
+
<base id="base_target" target="_parent" />
|
20
|
+
</head>
|
21
|
+
<body>
|
22
|
+
<div id="content">
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<ul id="full_list" class="file">
|
45
|
+
|
46
|
+
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
</ul>
|
54
|
+
</div>
|
55
|
+
</body>
|
56
|
+
</html>
|
data/doc/frames.html
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.0</title>
|
6
|
+
</head>
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
+
var name = match ? match[1] : 'index.html';
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
+
window.top.location = name;
|
12
|
+
</script>
|
13
|
+
<noscript>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
16
|
+
</noscript>
|
17
|
+
</html>
|
data/doc/index.html
ADDED
@@ -0,0 +1,160 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.0
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
61
|
+
|
62
|
+
<div id="content"><div id='filecontents'>
|
63
|
+
<h1 id="label-PipedriveRuby">PipedriveRuby</h1>
|
64
|
+
|
65
|
+
<p><a
|
66
|
+
href="https://codeclimate.com/github/lypborges/pipedrive_ruby/coverage"><img
|
67
|
+
src="https://travis-ci.org/lypborges/pipedrive_ruby.svg?branch=master}[https://travis-ci.org/lypborges/pipedrive_ruby]<a href="rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg" target="_parent" title="rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg">rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/gpa.svg</a>[https://codeclimate.com/github/lypborges/pipedrive_ruby]{rdoc-image:https://codeclimate.com/github/lypborges/pipedrive_ruby/badges/coverage.svg"></a></p>
|
68
|
+
|
69
|
+
<p>It's a working in progress.</p>
|
70
|
+
|
71
|
+
<h2 id="label-Tested+with+Ruby+versions-3A">Tested with Ruby versions:</h2>
|
72
|
+
<ul><li>
|
73
|
+
<p>2.0.0</p>
|
74
|
+
</li><li>
|
75
|
+
<p>2.1.9</p>
|
76
|
+
</li><li>
|
77
|
+
<p>2.2.5</p>
|
78
|
+
</li><li>
|
79
|
+
<p>2.3.1</p>
|
80
|
+
</li></ul>
|
81
|
+
|
82
|
+
<p>Welcome to your new gem! To experiment with that code, run
|
83
|
+
<code>bin/console</code> for an interactive prompt.</p>
|
84
|
+
|
85
|
+
<h2 id="label-Installation">Installation</h2>
|
86
|
+
|
87
|
+
<p>Add this line to your application's Gemfile:</p>
|
88
|
+
|
89
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pipedrive_ruby</span><span class='tstring_end'>'</span></span>
|
90
|
+
</code></pre>
|
91
|
+
|
92
|
+
<p>And then execute:</p>
|
93
|
+
|
94
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
95
|
+
|
96
|
+
<p>Or install it yourself as:</p>
|
97
|
+
|
98
|
+
<pre class="code ruby"><code class="ruby">$ gem install pipedrive_ruby --pre</code></pre>
|
99
|
+
|
100
|
+
<h2 id="label-Usage">Usage</h2>
|
101
|
+
|
102
|
+
<p>See Wiki <a href="https://github.com/lypborges/pipedrive_ruby/wiki">getting
|
103
|
+
started!</a></p>
|
104
|
+
|
105
|
+
<h2 id="label-Development">Development</h2>
|
106
|
+
|
107
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
108
|
+
dependencies. Then, run <code>rake spec</code> to run the tests. You can
|
109
|
+
also run <code>bin/console</code> for an interactive prompt that will allow
|
110
|
+
you to experiment.</p>
|
111
|
+
|
112
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
113
|
+
install</code>. To release a new version, update the version number in
|
114
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
115
|
+
release</code>, which will create a git tag for the version, push git
|
116
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
117
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
118
|
+
|
119
|
+
<h2 id="label-Contributing">Contributing</h2>
|
120
|
+
|
121
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
122
|
+
href="https://github.com/lypborges/pipedrive_ruby">github.com/lypborges/pipedrive_ruby</a>.
|
123
|
+
This project is intended to be a safe, welcoming space for collaboration,
|
124
|
+
and contributors are expected to adhere to the <a
|
125
|
+
href="http://contributor-covenant.org">Contributor Covenant</a> code of
|
126
|
+
conduct.</p>
|
127
|
+
|
128
|
+
<h2 id="label-Publishing+new+version+with">Publishing new version with</h2>
|
129
|
+
<ul><li>
|
130
|
+
<p>Using <a
|
131
|
+
href="https://github.com/svenfuchs/gem-release">github.com/svenfuchs/gem-release</a></p>
|
132
|
+
</li><li>
|
133
|
+
<p><code>gem install gem-release</code> if you don't have.</p>
|
134
|
+
</li><li>
|
135
|
+
<p><code>gem bump --version pre</code>, this will change the version according</p>
|
136
|
+
</li><li>
|
137
|
+
<p><code>gem release --tag</code> this will, publish to rubygems.org and tag
|
138
|
+
on github</p>
|
139
|
+
</li></ul>
|
140
|
+
|
141
|
+
<h2 id="label-Tips">Tips</h2>
|
142
|
+
|
143
|
+
<p>before push/pull requests always run tests: - <code>codeclimate
|
144
|
+
analyze</code> - <code>spec</code></p>
|
145
|
+
|
146
|
+
<h2 id="label-License">License</h2>
|
147
|
+
|
148
|
+
<p>The gem is available as open source under the terms of the <a
|
149
|
+
href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
150
|
+
</div></div>
|
151
|
+
|
152
|
+
<div id="footer">
|
153
|
+
Generated on Tue Jul 19 12:47:24 2016 by
|
154
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
155
|
+
0.9.0 (ruby-2.2.5).
|
156
|
+
</div>
|
157
|
+
|
158
|
+
</div>
|
159
|
+
</body>
|
160
|
+
</html>
|
data/doc/js/app.js
ADDED
@@ -0,0 +1,243 @@
|
|
1
|
+
(function() {
|
2
|
+
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
6
|
+
|
7
|
+
function createSourceLinks() {
|
8
|
+
$('.method_details_list .source_code').
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
10
|
+
$('.toggleSource').toggle(function() {
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
12
|
+
$(this).text("Hide source");
|
13
|
+
},
|
14
|
+
function() {
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
16
|
+
$(this).text("View source");
|
17
|
+
});
|
18
|
+
}
|
19
|
+
|
20
|
+
function createDefineLinks() {
|
21
|
+
var tHeight = 0;
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
23
|
+
$('.toggleDefines').toggle(function() {
|
24
|
+
tHeight = $(this).parent().prev().height();
|
25
|
+
$(this).prev().css('display', 'inline');
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
27
|
+
$(this).text("(less)");
|
28
|
+
},
|
29
|
+
function() {
|
30
|
+
$(this).prev().hide();
|
31
|
+
$(this).parent().prev().height(tHeight);
|
32
|
+
$(this).text("more...");
|
33
|
+
});
|
34
|
+
}
|
35
|
+
|
36
|
+
function createFullTreeLinks() {
|
37
|
+
var tHeight = 0;
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
39
|
+
tHeight = $(this).parent().prev().height();
|
40
|
+
$(this).parent().toggleClass('showAll');
|
41
|
+
$(this).text("(hide)");
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
43
|
+
},
|
44
|
+
function() {
|
45
|
+
$(this).parent().toggleClass('showAll');
|
46
|
+
$(this).parent().prev().height(tHeight);
|
47
|
+
$(this).text("show all");
|
48
|
+
});
|
49
|
+
}
|
50
|
+
|
51
|
+
function searchFrameButtons() {
|
52
|
+
$('.full_list_link').click(function() {
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
+
return false;
|
55
|
+
});
|
56
|
+
window.addEventListener('message', function(e) {
|
57
|
+
if (e.data === 'navEscape') {
|
58
|
+
$('#search_frame').slideUp(100);
|
59
|
+
$('#search a').removeClass('active inactive');
|
60
|
+
$(window).focus();
|
61
|
+
}
|
62
|
+
});
|
63
|
+
|
64
|
+
$(window).resize(function() {
|
65
|
+
if ($('#search:visible').length === 0) {
|
66
|
+
$('#search_frame').slideUp(100);
|
67
|
+
$('#search a').removeClass('active inactive');
|
68
|
+
$(window).focus();
|
69
|
+
}
|
70
|
+
});
|
71
|
+
}
|
72
|
+
|
73
|
+
function toggleSearchFrame(id, link) {
|
74
|
+
var frame = $('#search_frame');
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
77
|
+
frame.slideUp(100);
|
78
|
+
$('#search a').removeClass('active inactive');
|
79
|
+
}
|
80
|
+
else {
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
83
|
+
frame.slideDown(100);
|
84
|
+
}
|
85
|
+
}
|
86
|
+
|
87
|
+
function linkSummaries() {
|
88
|
+
$('.summary_signature').click(function() {
|
89
|
+
document.location = $(this).find('a').attr('href');
|
90
|
+
});
|
91
|
+
}
|
92
|
+
|
93
|
+
function summaryToggle() {
|
94
|
+
$('.summary_toggle').click(function(e) {
|
95
|
+
e.preventDefault();
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
97
|
+
$('.summary_toggle').each(function() {
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
100
|
+
if (next.hasClass('compact')) {
|
101
|
+
next.toggle();
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
103
|
+
}
|
104
|
+
else if (next.hasClass('summary')) {
|
105
|
+
var list = $('<ul class="summary compact" />');
|
106
|
+
list.html(next.html());
|
107
|
+
list.find('.summary_desc, .note').remove();
|
108
|
+
list.find('a').each(function() {
|
109
|
+
$(this).html($(this).find('strong').html());
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
111
|
+
});
|
112
|
+
next.before(list);
|
113
|
+
next.toggle();
|
114
|
+
}
|
115
|
+
});
|
116
|
+
return false;
|
117
|
+
});
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
119
|
+
$('.summary_toggle').first().click();
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
121
|
+
}
|
122
|
+
|
123
|
+
function generateTOC() {
|
124
|
+
if ($('#filecontents').length === 0) return;
|
125
|
+
var _toc = $('<ol class="top"></ol>');
|
126
|
+
var show = false;
|
127
|
+
var toc = _toc;
|
128
|
+
var counter = 0;
|
129
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
130
|
+
var i;
|
131
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
132
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
133
|
+
var lastTag = parseInt(tags[0][1], 10);
|
134
|
+
$(tags.join(', ')).each(function() {
|
135
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
136
|
+
if (this.id == "filecontents") return;
|
137
|
+
show = true;
|
138
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
139
|
+
if (this.id.length === 0) {
|
140
|
+
var proposedId = $(this).attr('toc-id');
|
141
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
142
|
+
else {
|
143
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
144
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
145
|
+
this.id = proposedId;
|
146
|
+
}
|
147
|
+
}
|
148
|
+
if (thisTag > lastTag) {
|
149
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
150
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
151
|
+
}
|
152
|
+
}
|
153
|
+
if (thisTag < lastTag) {
|
154
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
155
|
+
}
|
156
|
+
var title = $(this).attr('toc-title');
|
157
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
158
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
159
|
+
lastTag = thisTag;
|
160
|
+
});
|
161
|
+
if (!show) return;
|
162
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
163
|
+
$('#content').prepend(html);
|
164
|
+
$('#toc').append(_toc);
|
165
|
+
$('#toc .hide_toc').toggle(function() {
|
166
|
+
$('#toc .top').slideUp('fast');
|
167
|
+
$('#toc').toggleClass('hidden');
|
168
|
+
$('#toc .title small').toggle();
|
169
|
+
}, function() {
|
170
|
+
$('#toc .top').slideDown('fast');
|
171
|
+
$('#toc').toggleClass('hidden');
|
172
|
+
$('#toc .title small').toggle();
|
173
|
+
});
|
174
|
+
}
|
175
|
+
|
176
|
+
function navResizeFn(e) {
|
177
|
+
if (e.which !== 1) {
|
178
|
+
navResizeFnStop();
|
179
|
+
return;
|
180
|
+
}
|
181
|
+
|
182
|
+
sessionStorage.navWidth = e.pageX.toString();
|
183
|
+
$('.nav_wrap').css('width', e.pageX);
|
184
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
185
|
+
}
|
186
|
+
|
187
|
+
function navResizeFnStop() {
|
188
|
+
$(window).unbind('mousemove', navResizeFn);
|
189
|
+
window.removeEventListener('message', navMessageFn, false);
|
190
|
+
}
|
191
|
+
|
192
|
+
function navMessageFn(e) {
|
193
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
194
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
195
|
+
}
|
196
|
+
|
197
|
+
function navResizer() {
|
198
|
+
$('#resizer').mousedown(function(e) {
|
199
|
+
e.preventDefault();
|
200
|
+
$(window).mousemove(navResizeFn);
|
201
|
+
window.addEventListener('message', navMessageFn, false);
|
202
|
+
});
|
203
|
+
$(window).mouseup(navResizeFnStop);
|
204
|
+
|
205
|
+
if (sessionStorage.navWidth) {
|
206
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
207
|
+
}
|
208
|
+
}
|
209
|
+
|
210
|
+
function navExpander() {
|
211
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
212
|
+
function postMessage() {
|
213
|
+
if (done) return;
|
214
|
+
clearTimeout(timer);
|
215
|
+
var opts = { action: 'expand', path: pathId };
|
216
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
217
|
+
done = true;
|
218
|
+
}
|
219
|
+
|
220
|
+
window.addEventListener('message', function(event) {
|
221
|
+
if (event.data === 'navReady') postMessage();
|
222
|
+
return false;
|
223
|
+
}, false);
|
224
|
+
}
|
225
|
+
|
226
|
+
function mainFocus() {
|
227
|
+
$('#main')[0].focus();
|
228
|
+
}
|
229
|
+
|
230
|
+
$(document).ready(function() {
|
231
|
+
navResizer();
|
232
|
+
navExpander();
|
233
|
+
createSourceLinks();
|
234
|
+
createDefineLinks();
|
235
|
+
createFullTreeLinks();
|
236
|
+
searchFrameButtons();
|
237
|
+
linkSummaries();
|
238
|
+
summaryToggle();
|
239
|
+
generateTOC();
|
240
|
+
mainFocus();
|
241
|
+
});
|
242
|
+
|
243
|
+
})();
|