├── .gitignore ├── CHANGES.md ├── COPYING ├── README.md ├── Rakefile ├── bin └── git-ssh ├── lib ├── git-ssh.rb └── git-ssh │ ├── command.rb │ ├── gemspec.rb │ ├── specification.rb │ └── version.rb └── tasks ├── announce.rake ├── distribution.rake ├── documentation.rake └── setup.rb /.gitignore: -------------------------------------------------------------------------------- 1 | pkg 2 | -------------------------------------------------------------------------------- /CHANGES.md: -------------------------------------------------------------------------------- 1 | git-ssh Changelog 2 | ================= 3 | 4 | WIP 5 | --- 6 | 7 | + Made Readme and Changelog compatible with markadown 8 | 9 | Version 0.2.0 10 | ------------- 11 | 12 | + Added a little documentation 13 | + Added a version command line option 14 | 15 | Version 0.1.0 16 | ------------- 17 | 18 | + Initial public release 19 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | git-ssh 2 | ======= 3 | 4 | `git-ssh` is a proxy to serve git repositories over ssh. 5 | 6 | DESCRIPTION 7 | =========== 8 | 9 | `git-ssh` can force your ssh server to handle only git requests. You can allow 10 | your users to pull or push, but not to login or to do scp or sftp. 11 | 12 | FEATURES 13 | ======== 14 | 15 | + No other account creation to handle a new commiter. 16 | + Can chroot to a directory to limit access of the repository server. 17 | 18 | Later : 19 | 20 | + Can allow read, write or none access to a repository on a user basis. 21 | 22 | SYNOPSIS 23 | ======== 24 | 25 | Create a git user account 26 | 27 | # groupadd git 28 | # useradd -g git -h /var/git -m git 29 | # passwd 30 | 31 | You need to put a strong password that you can immediately forget. 32 | 33 | Prepare for ssh keys 34 | 35 | # mkdir ~git/.ssh 36 | # touch ~git/.ssh/authorized_keys 37 | # chown -R git:git ~git/.ssh 38 | # chmod 700 ~git/.ssh 39 | 40 | When you have to add a key in the `~git/.ssh/authorized_keys`, simply add at the beginning of the line : 41 | 42 | command="/usr/bin/git-ssh -r /var/git lemarsu" 43 | 44 | For example: 45 | 46 | command="/usr/bin/git-ssh -r /var/git lemarsu" ssh-dss [...] lemarsu@zorglub 47 | 48 | The `-r` option ask `git-ssh` to chroot the folder `/var/git`. This way, the 49 | users cannot get away from the directory of repositories. 50 | 51 | CREDITS 52 | ======= 53 | 54 | LeMarsu `` 55 | 56 | LICENSE 57 | ======= 58 | 59 | See file COPYING. 60 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # make sure our project's ./lib directory is added to the ruby search path 2 | $: << File.join(File.dirname(__FILE__),"lib") 3 | 4 | require 'rubygems' 5 | require 'rake/gempackagetask' 6 | require 'rake/clean' 7 | require 'rake/rdoctask' 8 | require 'rake/contrib/sshpublisher' 9 | 10 | require 'git-ssh' 11 | 12 | load 'tasks/setup.rb' 13 | 14 | 15 | -------------------------------------------------------------------------------- /bin/git-ssh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | begin 4 | require 'git-ssh' 5 | rescue LoadError 6 | path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib")) 7 | raise if $:.include?(path) 8 | $: << path 9 | retry 10 | end 11 | 12 | begin 13 | GitSsh::Command.new(*ARGV).run 14 | rescue GitSsh::Command::ShellError => ex 15 | STDERR.puts ex.message 16 | rescue GitSsh::Command::UsageError => ex 17 | STDERR.puts ex.message 18 | rescue Exception => ex 19 | # For debug 20 | raise 21 | end 22 | 23 | 24 | # vim: ts=8 sw=2 25 | # vim70: fdm=syntax fdl=1 26 | -------------------------------------------------------------------------------- /lib/git-ssh.rb: -------------------------------------------------------------------------------- 1 | module GitSsh 2 | 3 | ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__),"..")) 4 | LIB_DIR = File.join(ROOT_DIR,"lib").freeze 5 | RESOURCE_DIR = File.join(ROOT_DIR,"resources").freeze 6 | 7 | # Utility method to require all files ending in .rb in the directory 8 | # with the same name as this file minus .rb 9 | def require_all_libs_relative_to(fname) 10 | prepend = File.basename(fname,".rb") 11 | search_me = File.join(File.dirname(fname),prepend) 12 | 13 | Dir.entries(search_me).each do |rb| 14 | if File.extname(rb) == ".rb" then 15 | require "#{prepend}/#{File.basename(rb,".rb")}" 16 | end 17 | end 18 | end 19 | module_function :require_all_libs_relative_to 20 | 21 | end 22 | 23 | GitSsh.require_all_libs_relative_to(__FILE__) 24 | -------------------------------------------------------------------------------- /lib/git-ssh/command.rb: -------------------------------------------------------------------------------- 1 | require 'optparse' 2 | 3 | class GitSsh::Command 4 | 5 | COMMANDS_RE = /^(git-(?:receive|upload)-pack) '(.*)'$/o 6 | SSH_COMMAND = 'SSH_ORIGINAL_COMMAND' 7 | 8 | class UsageError < Exception; end 9 | class ShellError < Exception; end 10 | 11 | Options = Struct.new("Options", :verbose, :chroot) 12 | 13 | def initialize(*args) 14 | parse_args(*args) 15 | parse_ssh_original_command 16 | end 17 | 18 | def run 19 | exec *command_line 20 | STDERR.puts "Exec sucked!" 21 | end 22 | 23 | def command_line 24 | path = @options.chroot ? File.join(@options.chroot, @path) : @path 25 | [@command, path] 26 | end 27 | 28 | private 29 | 30 | def parse_args(*args) 31 | @args = args 32 | @options = Options.new(false, false) 33 | parser = get_parser 34 | args_left = parser.parse!(@args) 35 | raise UsageError, "#$0 usage: #$0 " unless 36 | args_left.size == 1 && args_left.first =~ /^\w+$/ 37 | @user = @args.first 38 | end 39 | 40 | def get_parser 41 | OptionParser.new do |o| 42 | o.banner = "Usage: #$0 [options] " 43 | 44 | o.separator "" 45 | o.separator "Options:" 46 | 47 | o.on '-r DIR', '--chroot=DIR', 'Chroot the user' do |value| 48 | @options.chroot = value 49 | end 50 | o.on('-v', '--verbose', 'Be verbose') { @options.verbose = true } 51 | o.on('-V', '--version', 'Get the version') do 52 | puts "#$0 v#{GitSsh::VERSION}" 53 | exit 0 54 | end 55 | end 56 | end 57 | 58 | def parse_ssh_original_command 59 | raise ShellError, "What do you think I am? A shell?" unless 60 | ENV.keys.include?(SSH_COMMAND) 61 | raise ShellError, "It seems dangerous" unless 62 | mg = COMMANDS_RE.match(ENV[SSH_COMMAND]) 63 | @command = mg[1] 64 | @path = sanitize_path mg[2] 65 | end 66 | 67 | def sanitize_path(path) 68 | test_path = path[0] == ?/ ? path : File.join('/', path) 69 | File.expand_path(test_path) 70 | end 71 | 72 | end 73 | -------------------------------------------------------------------------------- /lib/git-ssh/gemspec.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'git-ssh/specification' 3 | require 'git-ssh/version' 4 | require 'rake' 5 | 6 | # The Gem Specification plus some extras for git-ssh. 7 | module GitSsh 8 | SPEC = GitSsh::Specification.new do |spec| 9 | spec.name = "git-ssh" 10 | spec.version = GitSsh::VERSION 11 | spec.rubyforge_project = "git-ssh" 12 | spec.author = "LeMarsu" 13 | spec.email = "ch.ruelle@lemarsu.com" 14 | spec.homepage = "http://git-ssh.rubyforge.org/" 15 | 16 | spec.summary = "A Summary of git-ssh." 17 | spec.description = <<-DESC 18 | A longer more detailed description of git-ssh. 19 | DESC 20 | 21 | spec.extra_rdoc_files = FileList["[A-Z]*"] 22 | spec.has_rdoc = true 23 | spec.rdoc_main = "README" 24 | spec.rdoc_options = [ "--line-numbers" , "--inline-source" ] 25 | 26 | spec.test_files = FileList["spec/**/*.rb", "test/**/*.rb"] 27 | spec.files = spec.test_files + spec.extra_rdoc_files + 28 | FileList["lib/**/*.rb", "resources/**/*"] 29 | 30 | spec.executable = spec.name 31 | 32 | 33 | # add dependencies 34 | # spec.add_dependency("somegem", ">= 0.4.2") 35 | 36 | spec.platform = Gem::Platform::RUBY 37 | 38 | spec.local_rdoc_dir = "doc/rdoc" 39 | spec.remote_rdoc_dir = "#{spec.name}/rdoc" 40 | spec.local_coverage_dir = "doc/coverage" 41 | spec.remote_coverage_dir= "#{spec.name}/coverage" 42 | 43 | spec.remote_site_dir = "#{spec.name}/" 44 | 45 | end 46 | end 47 | 48 | 49 | -------------------------------------------------------------------------------- /lib/git-ssh/specification.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'rubygems/specification' 3 | require 'rake' 4 | 5 | module GitSsh 6 | # Add some additional items to Gem::Specification 7 | # A GitSsh::Specification adds additional pieces of information the 8 | # typical gem specification 9 | class Specification 10 | 11 | RUBYFORGE_ROOT = "/var/www/gforge-projects/" 12 | 13 | # user that accesses remote site 14 | attr_accessor :remote_user 15 | 16 | # remote host, default 'rubyforge.org' 17 | attr_accessor :remote_host 18 | 19 | # name the rdoc main 20 | attr_accessor :rdoc_main 21 | 22 | # local directory in development holding the generated rdoc 23 | # default 'doc' 24 | attr_accessor :local_rdoc_dir 25 | 26 | # remote directory for storing rdoc, default 'doc' 27 | attr_accessor :remote_rdoc_dir 28 | 29 | # local directory for coverage report 30 | attr_accessor :local_coverage_dir 31 | 32 | # remote directory for storing coverage reports 33 | # This defaults to 'coverage' 34 | attr_accessor :remote_coverage_dir 35 | 36 | # local directory for generated website, default +site/public+ 37 | attr_accessor :local_site_dir 38 | 39 | # remote directory relative to +remote_root+ for the website. 40 | # website. 41 | attr_accessor :remote_site_dir 42 | 43 | # is a .tgz to be created?, default 'true' 44 | attr_accessor :need_tar 45 | 46 | # is a .zip to be created, default 'true' 47 | attr_accessor :need_zip 48 | 49 | 50 | def initialize 51 | @remote_user = nil 52 | @remote_host = "rubyforge.org" 53 | 54 | @rdoc_main = "README" 55 | @local_rdoc_dir = "doc" 56 | @remote_rdoc_dir = "doc" 57 | @local_coverage_dir = "coverage" 58 | @remote_coverage_dir = "coverage" 59 | @local_site_dir = "site/public" 60 | @remote_site_dir = "." 61 | 62 | @need_tar = true 63 | @need_zip = true 64 | 65 | @spec = Gem::Specification.new 66 | 67 | yield self if block_given? 68 | 69 | # update rdoc options to take care of the rdoc_main if it is 70 | # there, and add a default title if one is not given 71 | if not @spec.rdoc_options.include?("--main") then 72 | @spec.rdoc_options.concat(["--main", rdoc_main]) 73 | end 74 | 75 | if not @spec.rdoc_options.include?("--title") then 76 | @spec.rdoc_options.concat(["--title","'#{name} -- #{summary}'"]) 77 | end 78 | end 79 | 80 | # if this gets set then it overwrites what would be the 81 | # rubyforge default. If rubyforge project is not set then use 82 | # name. If rubyforge project and name are set, but they are 83 | # different then assume that name is a subproject of the 84 | # rubyforge project 85 | def remote_root 86 | if rubyforge_project.nil? or 87 | rubyforge_project == name then 88 | return RUBYFORGE_ROOT + "#{name}/" 89 | else 90 | return RUBYFORGE_ROOT + "#{rubyforge_project}/#{name}/" 91 | end 92 | end 93 | 94 | # rdoc files is the same as what would be generated during gem 95 | # installation. That is, everything in the require paths plus 96 | # the rdoc_extra_files 97 | # 98 | def rdoc_files 99 | flist = extra_rdoc_files.dup 100 | @spec.require_paths.each do |rp| 101 | flist << FileList["#{rp}/**/*.rb"] 102 | end 103 | flist.flatten.uniq 104 | end 105 | 106 | # calculate the remote directories 107 | def remote_root_location 108 | "#{remote_user}@#{remote_host}:#{remote_root}" 109 | end 110 | 111 | def remote_rdoc_location 112 | remote_root_location + @remote_rdoc_dir 113 | end 114 | 115 | def remote_coverage_location 116 | remote_root_loation + @remote_coverage_dir 117 | end 118 | 119 | def remote_site_location 120 | remote_root_location + @remote_site_dir 121 | end 122 | 123 | # we delegate any other calls to spec 124 | def method_missing(method_id,*params,&block) 125 | @spec.send method_id, *params, &block 126 | end 127 | end 128 | end 129 | -------------------------------------------------------------------------------- /lib/git-ssh/version.rb: -------------------------------------------------------------------------------- 1 | module GitSsh 2 | class Version 3 | MAJOR = 0 4 | MINOR = 2 5 | BUILD = 0 6 | 7 | class << self 8 | def to_a 9 | [MAJOR, MINOR, BUILD] 10 | end 11 | 12 | def to_s 13 | to_a.join(".") 14 | end 15 | end 16 | end 17 | VERSION = Version.to_s 18 | end 19 | -------------------------------------------------------------------------------- /tasks/announce.rake: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------- 2 | # Announcement tasks 3 | # - create a basic email template that can be used to send email to 4 | # rubytalk. 5 | #----------------------------------------------------------------------- 6 | def changes 7 | change_file = File.expand_path(File.join(GitSsh::ROOT_DIR,"CHANGES")) 8 | sections = File.read(change_file).split(/^(?===)/) 9 | end 10 | 11 | def last_changeset 12 | changes[1] 13 | end 14 | 15 | def announcement 16 | urls = " #{GitSsh::SPEC.homepage}" 17 | subject = "#{GitSsh::SPEC.name} #{GitSsh::VERSION} Released" 18 | title = "#{GitSsh::SPEC.name} version #{GitSsh::VERSION} has been released." 19 | body = <" 38 | mail.puts "To: ruby-talk@ruby-lang.org" 39 | mail.puts "Date: #{Time.now.rfc2822}" 40 | mail.puts "Subject: [ANN] #{subject}" 41 | mail.puts 42 | mail.puts title 43 | mail.puts 44 | mail.puts urls 45 | mail.puts 46 | mail.puts body 47 | mail.puts 48 | mail.puts urls 49 | end 50 | puts "Created the following as email.txt:" 51 | puts "-" * 72 52 | puts File.read("email.txt") 53 | puts "-" * 72 54 | end 55 | 56 | CLOBBER << "email.txt" 57 | end 58 | -------------------------------------------------------------------------------- /tasks/distribution.rake: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------- 2 | # Distribution and Packaging 3 | #----------------------------------------------------------------------- 4 | namespace :dist do 5 | 6 | GEM_SPEC = eval(GitSsh::SPEC.to_ruby) 7 | 8 | Rake::GemPackageTask.new(GEM_SPEC) do |pkg| 9 | pkg.need_tar = GitSsh::SPEC.need_tar 10 | pkg.need_zip = GitSsh::SPEC.need_zip 11 | end 12 | 13 | desc "Install as a gem" 14 | task :install => [:clobber, :package] do 15 | sh "sudo gem install pkg/#{GitSsh::SPEC.full_name}.gem" 16 | end 17 | 18 | # uninstall the gem and all executables 19 | desc "Uninstall gem" 20 | task :uninstall do 21 | sh "sudo gem uninstall #{GitSsh::SPEC.name} -x" 22 | end 23 | 24 | desc "dump gemspec" 25 | task :gemspec do 26 | puts GitSsh::SPEC.to_ruby 27 | end 28 | 29 | desc "reinstall gem" 30 | task :reinstall => [:uninstall, :install] 31 | 32 | end 33 | -------------------------------------------------------------------------------- /tasks/documentation.rake: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------- 2 | # Documentation 3 | #----------------------------------------------------------------------- 4 | 5 | namespace :doc do 6 | 7 | # generating documentation locally 8 | Rake::RDocTask.new do |rdoc| 9 | rdoc.rdoc_dir = GitSsh::SPEC.local_rdoc_dir 10 | rdoc.options = GitSsh::SPEC.rdoc_options 11 | rdoc.rdoc_files = GitSsh::SPEC.rdoc_files 12 | end 13 | 14 | desc "Deploy the RDoc documentation to #{GitSsh::SPEC.remote_rdoc_location}" 15 | task :deploy => :rerdoc do 16 | sh "rsync -zav --delete #{GitSsh::SPEC.local_rdoc_dir}/ #{GitSsh::SPEC.remote_rdoc_location}" 17 | end 18 | 19 | if HAVE_HEEL then 20 | desc "View the RDoc documentation locally" 21 | task :view => :rdoc do 22 | sh "heel --root #{GitSsh::SPEC.local_rdoc_dir}" 23 | end 24 | end 25 | end 26 | -------------------------------------------------------------------------------- /tasks/setup.rb: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------- 2 | # Try to load the given _library_ using the built-in require, but do not 3 | # raise a LoadError if unsuccessful. Returns +true+ if the _library_ was 4 | # successfully loaded; returns +false+ otherwise. 5 | #----------------------------------------------------------------------- 6 | def try_require( lib ) 7 | require lib 8 | true 9 | rescue LoadError 10 | false 11 | end 12 | 13 | #----------------------------------------------------------------------- 14 | # setup global constants so the task libs can make decisions based upon 15 | # the availability of other libraries. 16 | # - heel is a mongrel based webserver used to serve up files locally 17 | # - webby is a static site generation tool 18 | # - rubyforge is self explanatory 19 | #----------------------------------------------------------------------- 20 | %w(heel webby rubyforge).each do |lib| 21 | Object.instance_eval { const_set "HAVE_#{lib.upcase}", try_require(lib) } 22 | end 23 | 24 | #----------------------------------------------------------------------- 25 | # load all the extra tasks for the project and setup the default task 26 | # the test:default is set by the spec or by the testunit library. 27 | #----------------------------------------------------------------------- 28 | FileList["tasks/*.rake"].each { |tasklib| import tasklib } 29 | 30 | task :default => 'test:default' 31 | 32 | #----------------------------------------------------------------------- 33 | # update the top level clobber task to depend on all possible sub-level 34 | # tasks that have a name like ':clobber' in other namespaces 35 | #----------------------------------------------------------------------- 36 | Rake.application.tasks.each do |t| 37 | if t.name =~ /:clobber/ then 38 | task :clobber => [t.name] 39 | end 40 | end 41 | --------------------------------------------------------------------------------