├── .coveragerc ├── .flake8 ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── lib └── gitem │ ├── __init__.py │ ├── __main__.py │ ├── analytics.py │ ├── api.py │ └── output │ ├── __init__.py │ ├── base.py │ ├── json.py │ └── stdout.py ├── requirements-dev.txt ├── requirements.txt ├── setup.cfg ├── setup.py └── tests ├── mocked_api_results.py ├── test_analytics.py ├── test_api.py └── test_output ├── test_json.py └── test_stdout.py /.coveragerc: -------------------------------------------------------------------------------- 1 | [report] 2 | include = lib/* 3 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | ignore = E501,W503 3 | include = lib,tests 4 | exclude = setup.py 5 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Dlint 2 | on: [push, pull_request] 3 | jobs: 4 | dlint: 5 | runs-on: ubuntu-latest 6 | name: Dlint 7 | steps: 8 | - uses: actions/checkout@master 9 | - uses: dlint-py/dlint-action@master 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .coverage.* 40 | .cache 41 | nosetests.xml 42 | coverage.xml 43 | *,cover 44 | .hypothesis/ 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | local_settings.py 53 | 54 | # Flask stuff: 55 | instance/ 56 | .webassets-cache 57 | 58 | # Scrapy stuff: 59 | .scrapy 60 | 61 | # Sphinx documentation 62 | docs/_build/ 63 | 64 | # PyBuilder 65 | target/ 66 | 67 | # IPython Notebook 68 | .ipynb_checkpoints 69 | 70 | # pyenv 71 | .python-version 72 | 73 | # celery beat schedule file 74 | celerybeat-schedule 75 | 76 | # dotenv 77 | .env 78 | 79 | # virtualenv 80 | venv/ 81 | ENV/ 82 | 83 | # Spyder project settings 84 | .spyderproject 85 | 86 | # Rope project settings 87 | .ropeproject 88 | 89 | # Vim swap files 90 | *.sw[op] 91 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: xenial 2 | language: python 3 | cache: pip 4 | python: 5 | - 2.7 6 | - 3.5 7 | - 3.6 8 | - 3.7 9 | - 3.8-dev 10 | before_install: 11 | - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install mock; fi 12 | install: 13 | - pip install -r requirements.txt 14 | - pip install -r requirements-dev.txt 15 | - pip install -e . 16 | script: 17 | - flake8 18 | - pytest --cov 19 | after_success: 20 | - coveralls 21 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to this project will be documented in this file. 3 | This project adheres to [Semantic Versioning](http://semver.org/). 4 | This project adheres to [CHANGELOG](http://keepachangelog.com/). 5 | 6 | ## [Unreleased] 7 | 8 | ## [0.9.2] - 2018-11-22 9 | ### Fixed 10 | - Python package version classifiers 11 | 12 | ## [0.9.1] - 2018-11-22 13 | ### Fixed 14 | - Build when using Python 3.8 15 | 16 | ## [0.9.0] - 2019-11-22 17 | ### Added 18 | - Python 3.8 support 19 | 20 | ### Fixed 21 | - Specifying incorrect contributor information ([#10](https://github.com/mschwager/gitem/issues/10)) 22 | 23 | ### Removed 24 | - Official Python 3.4 support, it's EOL 25 | 26 | ## [0.8.1] - 2018-11-06 27 | ### Security 28 | - Updated requests dependency per CVE-2018-18074 29 | 30 | ## [0.8.0] - 2018-10-12 31 | ### Added 32 | - The --output flag which supports JSON output 33 | 34 | ## [0.7.1] - 2018-07-12 35 | ### Fixed 36 | - Included README in package long_description 37 | 38 | ## [0.7.0] - 2018-07-12 39 | ### Added 40 | - Python 3.7 support 41 | - Clone URL information to repository queries 42 | 43 | ### Fixed 44 | - Avoid using builtin variable names 45 | 46 | ## [0.6.1] - 2018-02-06 47 | ### Fixed 48 | - Incorrect variable name used 49 | 50 | ### Removed 51 | - Python 3.3 support, it's EOL 52 | 53 | ## [0.6.0] - 2017-06-15 54 | ### Added 55 | - Python 3.6 support 56 | 57 | ## [0.5.1] - 2016-11-29 58 | ### Fixed 59 | - Added friendlier error message when resources not found 60 | 61 | ## [0.5.0] - 2016-10-02 62 | ### Added 63 | - Initial release of Gitem 64 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gitem 2 | 3 | [![Build Status](https://travis-ci.org/mschwager/gitem.svg?branch=master)](https://travis-ci.org/mschwager/gitem) 4 | [![Coverage Status](https://coveralls.io/repos/github/mschwager/gitem/badge.svg?branch=master)](https://coveralls.io/github/mschwager/gitem?branch=master) 5 | [![Dlint Status](https://github.com/mschwager/gitem/workflows/Dlint/badge.svg)](https://github.com/dlint-py/dlint-action) 6 | [![Python Versions](https://img.shields.io/pypi/pyversions/gitem.svg)](https://img.shields.io/pypi/pyversions/gitem.svg) 7 | [![PyPI Version](https://img.shields.io/pypi/v/gitem.svg)](https://img.shields.io/pypi/v/gitem.svg) 8 | 9 | `Gitem` is a tool for performing Github organizational reconnaissance. 10 | 11 | This could include information for: 12 | 13 | * [OSINT](https://en.wikipedia.org/wiki/Open-source_intelligence) 14 | * Spearphishing 15 | * Recruitment 16 | * Competitive analysis 17 | * OPSEC self-assessment 18 | 19 | # Installing 20 | 21 | ``` 22 | $ pip install gitem 23 | $ gitem -h 24 | ``` 25 | 26 | OR 27 | 28 | ``` 29 | $ git clone https://github.com/mschwager/gitem.git 30 | $ cd gitem 31 | $ pip install --requirement requirements.txt 32 | $ PYTHONPATH=lib/ python -m gitem -h 33 | ``` 34 | 35 | # Using 36 | 37 | `Gitem` can be used to collect information at various levels of granularity from Github. 38 | 39 | *Note, most commands will shorten output by default, specify `--verbose` to change this behavior* 40 | 41 | For example, let's grab some information about Facebook: 42 | 43 | ``` 44 | $ gitem organization facebook 45 | Website: https://code.facebook.com/projects/ 46 | Username: facebook 47 | Description: We work hard to contribute our work back to the web, mobile, big data, & infrastructure communities. NB: members must have two-factor auth. 48 | Created: 2009-04-02T03:35:22Z 49 | Github URL: https://github.com/facebook 50 | Last Updated: 2016-09-21T15:36:43Z 51 | # of Public Repositories: 173 52 | Location: Menlo Park, California 53 | Organization Name: Facebook 54 | Email Address: 55 | Public Members: 56 | ... 57 | 58 | Public Repositories: 59 | Repository Name: react 60 | Watchers: 50773 61 | Description: A declarative, efficient, and flexible JavaScript library for building user interfaces. 62 | Created: 2013-05-24T16:15:54Z 63 | Github URL: https://github.com/facebook/react 64 | Last Updated: 2016-10-01T15:09:54Z 65 | Stars: 50773 66 | Forks: 8855 67 | Last Pushed: 2016-10-01T14:27:58Z 68 | 69 | Repository Name: react-native 70 | Watchers: 38364 71 | Description: A framework for building native apps with React. 72 | Created: 2015-01-09T18:10:16Z 73 | Github URL: https://github.com/facebook/react-native 74 | Last Updated: 2016-10-01T14:37:29Z 75 | Stars: 38364 76 | Forks: 8531 77 | Last Pushed: 2016-10-01T14:15:31Z 78 | 79 | Repository Name: pop 80 | Watchers: 16481 81 | Description: An extensible iOS and OS X animation library, useful for physics-based interactions. 82 | Created: 2014-03-30T22:29:12Z 83 | Github URL: https://github.com/facebook/pop 84 | Last Updated: 2016-10-01T14:12:35Z 85 | Stars: 16481 86 | Forks: 2630 87 | Last Pushed: 2016-08-23T17:23:10Z 88 | 89 | ... 90 | ``` 91 | 92 | From here we can drill down into a certain repository: 93 | 94 | ``` 95 | $ gitem repository facebook react 96 | Repository Name: react 97 | Watchers: 50773 98 | Description: A declarative, efficient, and flexible JavaScript library for building user interfaces. 99 | Last Pushed: 2016-10-01T14:27:58Z 100 | Created: 2013-05-24T16:15:54Z 101 | Github URL: https://github.com/facebook/react 102 | Last Updated: 2016-10-01T15:09:54Z 103 | Language: JavaScript 104 | Stars: 50773 105 | Forks: 8855 106 | Homepage: https://facebook.github.io/react/ 107 | Contributors: 108 | Username: zpao 109 | Contributions: 1755 110 | Username: spicyj 111 | Contributions: 1108 112 | Username: jimfb 113 | Contributions: 456 114 | Username: sebmarkbage 115 | Contributions: 378 116 | Username: petehunt 117 | Contributions: 332 118 | ... 119 | ``` 120 | 121 | And finally, we can analyze specific users: 122 | 123 | *Note, this task is easily parallelizable, so we can specify `--processes 4`* 124 | 125 | ``` 126 | $ gitem --processes 4 user 127 | Username: 128 | Updated: 2016-09-29T02:06:31Z 129 | Name: 130 | Created: 2008-04-25T04:38:22Z 131 | Github URL: 132 | Company: Facebook 133 | Blog: 134 | Location: 135 | Email Address: 136 | Organizations: 137 | Organization: facebook 138 | Organization: reactjs 139 | Organization: relayjs 140 | Repositories: 141 | 142 | ... 143 | Emails: 144 | 145 | ... 146 | ``` 147 | 148 | # Developing 149 | 150 | First, install development packages: 151 | 152 | ``` 153 | $ pip install -r requirements-dev.txt 154 | $ pip install -e . 155 | ``` 156 | 157 | ## Testing 158 | 159 | ``` 160 | $ pytest 161 | ``` 162 | 163 | ## Linting 164 | 165 | ``` 166 | $ flake8 167 | ``` 168 | 169 | ## Coverage 170 | 171 | ``` 172 | $ pytest --cov 173 | ``` 174 | -------------------------------------------------------------------------------- /lib/gitem/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import ( 2 | absolute_import, 3 | division, 4 | print_function, 5 | unicode_literals, 6 | ) 7 | 8 | from . import api 9 | from . import analytics 10 | from . import output 11 | 12 | __name__ = 'gitem' 13 | __version__ = '0.9.2' 14 | __all__ = [ 15 | 'api', 16 | 'analytics', 17 | 'output', 18 | ] 19 | -------------------------------------------------------------------------------- /lib/gitem/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | import argparse 11 | import collections 12 | import functools 13 | import multiprocessing 14 | 15 | from . import api 16 | from . import analytics 17 | from . import output 18 | 19 | CONCISE_COUNT = 5 20 | 21 | 22 | def organization(ghapi, outputter, *args, **kwargs): 23 | organization = kwargs['name'] 24 | verbose = kwargs['verbose'] 25 | 26 | organization_info = analytics.get_organization_information( 27 | ghapi, 28 | organization 29 | ) 30 | 31 | outputter.output(organization_info) 32 | 33 | organization_members = analytics.get_organization_members( 34 | ghapi, 35 | organization 36 | ) 37 | 38 | def member_administrator(member): 39 | return member['Site Administrator'] 40 | 41 | members = sorted( 42 | organization_members, 43 | key=member_administrator, 44 | reverse=True 45 | ) 46 | 47 | member_count = len(members) if verbose else CONCISE_COUNT 48 | outputter.output(collections.OrderedDict([ 49 | ("Public Members", collections.OrderedDict([ 50 | (member["Username"], collections.OrderedDict([ 51 | (human_readable_name, api_info) 52 | for human_readable_name, api_info in member.items() 53 | ])) 54 | for member in members[:member_count] 55 | ])) 56 | ])) 57 | 58 | organization_repositories = analytics.get_organization_repositories( 59 | ghapi, 60 | organization 61 | ) 62 | 63 | def repository_popularity(repository): 64 | return ( 65 | int(repository['Watchers']) 66 | + int(repository['Stars']) 67 | + int(repository['Forks']) 68 | ) 69 | 70 | repositories = sorted( 71 | organization_repositories, 72 | key=repository_popularity, 73 | reverse=True 74 | ) 75 | 76 | repository_count = len(repositories) if verbose else CONCISE_COUNT 77 | outputter.output(collections.OrderedDict([ 78 | ("Public Repositories", collections.OrderedDict([ 79 | (repository["Repository Name"], collections.OrderedDict([ 80 | (human_readable_name, api_info) 81 | for human_readable_name, api_info in repository.items() 82 | ])) 83 | for repository in repositories[:repository_count] 84 | ])) 85 | ])) 86 | 87 | 88 | def repository(ghapi, outputter, *args, **kwargs): 89 | repository = kwargs['name'] 90 | owner = kwargs['owner'] 91 | verbose = kwargs['verbose'] 92 | 93 | repository_info = analytics.get_repository_information( 94 | ghapi, 95 | owner, 96 | repository 97 | ) 98 | 99 | outputter.output(repository_info) 100 | 101 | repository_contributors = analytics.get_repository_contributors( 102 | ghapi, 103 | owner, 104 | repository 105 | ) 106 | 107 | contributor_count = len(repository_contributors) if verbose else CONCISE_COUNT 108 | outputter.output(collections.OrderedDict([ 109 | ("Contributors", collections.OrderedDict([ 110 | (contributor["Username"], collections.OrderedDict([ 111 | (human_readable_name, api_info) 112 | for human_readable_name, api_info in contributor.items() 113 | ])) 114 | for contributor in repository_contributors[:contributor_count] 115 | ])) 116 | ])) 117 | 118 | 119 | def user(ghapi, outputter, *args, **kwargs): 120 | username = kwargs['name'] 121 | verbose = kwargs['verbose'] 122 | processes = kwargs['processes'] 123 | 124 | user_info = analytics.get_user_information( 125 | ghapi, 126 | username 127 | ) 128 | 129 | outputter.output(user_info) 130 | 131 | user_organizations = analytics.get_user_organizations( 132 | ghapi, 133 | username 134 | ) 135 | 136 | organization_count = len(user_organizations) if verbose else CONCISE_COUNT 137 | outputter.output(collections.OrderedDict([ 138 | ("Organizations", collections.OrderedDict([ 139 | (organization["Organization"], collections.OrderedDict([ 140 | (human_readable_name, api_info) 141 | for human_readable_name, api_info in organization.items() 142 | ])) 143 | for organization in user_organizations[:organization_count] 144 | ])) 145 | ])) 146 | 147 | user_repositories = analytics.get_user_repositories( 148 | ghapi, 149 | username 150 | ) 151 | 152 | repository_count = len(user_repositories) if verbose else CONCISE_COUNT 153 | outputter.output(collections.OrderedDict([ 154 | ("Repositories", collections.OrderedDict([ 155 | (repository["Repository Name"], collections.OrderedDict([ 156 | (human_readable_name, api_info) 157 | for human_readable_name, api_info in repository.items() 158 | ])) 159 | for repository in user_repositories[:repository_count] 160 | ])) 161 | ])) 162 | 163 | user_repository_names = [ 164 | repository['Repository Name'] 165 | for repository in user_repositories 166 | ] 167 | 168 | if processes: 169 | pool = multiprocessing.Pool(processes=processes) 170 | partial_email_fn = functools.partial( 171 | analytics.get_repository_commit_emails, 172 | ghapi, 173 | username, 174 | author=username 175 | ) 176 | user_repository_emails = pool.map(partial_email_fn, user_repository_names) 177 | else: 178 | user_repository_emails = [ 179 | analytics.get_repository_commit_emails( 180 | ghapi, 181 | username, 182 | repository, 183 | author=username 184 | ) 185 | for repository in user_repository_names 186 | ] 187 | 188 | user_emails = functools.reduce(set.union, user_repository_emails, set()) 189 | 190 | outputter.output(collections.OrderedDict([ 191 | ("Emails", [ 192 | str((name, email)) 193 | for name, email in user_emails 194 | ]), 195 | ])) 196 | 197 | 198 | def parse_args(): 199 | p = argparse.ArgumentParser(description=''' 200 | A Github organization reconnaissance tool. 201 | ''', formatter_class=argparse.RawTextHelpFormatter) 202 | 203 | p.add_argument( 204 | '-o', 205 | '--oauth2-token', 206 | action='store', 207 | help='OAuth2 token for authentcation' 208 | ) 209 | p.add_argument( 210 | '-v', 211 | '--verbose', 212 | action='store_true', 213 | help='verbose output' 214 | ) 215 | p.add_argument( 216 | '-p', 217 | '--processes', 218 | action='store', 219 | type=int, 220 | help='number of processes (for applicable commands)' 221 | ) 222 | p.add_argument( 223 | '-t', 224 | '--output', 225 | action='store', 226 | choices=[ 227 | output.Stdout.name, 228 | output.Json.name, 229 | ], 230 | default=output.Stdout.name, 231 | help='show results in this format' 232 | ) 233 | 234 | subparsers = p.add_subparsers(dest='command') 235 | 236 | organization = subparsers.add_parser('organization') 237 | organization.add_argument( 238 | 'name', 239 | action='store', 240 | help='Github organization name' 241 | ) 242 | 243 | repository = subparsers.add_parser('repository') 244 | repository.add_argument( 245 | 'owner', 246 | action='store', 247 | help='Github repository owner' 248 | ) 249 | repository.add_argument( 250 | 'name', 251 | action='store', 252 | help='Github repository name' 253 | ) 254 | 255 | user = subparsers.add_parser('user') 256 | user.add_argument( 257 | 'name', 258 | action='store', 259 | help='Github user name' 260 | ) 261 | 262 | args = p.parse_args() 263 | 264 | return args 265 | 266 | 267 | def main(): 268 | args = parse_args() 269 | 270 | dispatch = { 271 | "organization": organization, 272 | "repository": repository, 273 | "user": user, 274 | } 275 | 276 | ghapi = api.Api(args.oauth2_token) 277 | 278 | outputters = { 279 | output.Stdout.name: output.Stdout, 280 | output.Json.name: output.Json, 281 | } 282 | outputter = outputters[args.output]() 283 | 284 | try: 285 | dispatch[args.command](ghapi, outputter, **vars(args)) 286 | except api.ApiCallException as e: 287 | if e.rate_limiting: 288 | outputter.output({ 289 | "Error": ( 290 | "Your API requests are being rate-limited. " 291 | + "Please include an OAuth2 token and read the following:" 292 | ) 293 | }) 294 | outputter.output({ 295 | "Rate Limiting": e.rate_limiting_url 296 | }) 297 | elif e.not_found: 298 | outputter.output({ 299 | "Error": ( 300 | "The requested resource was not found or private. " 301 | + "Please confirm that it exists." 302 | ) 303 | }) 304 | else: 305 | # Re-raise original exception 306 | raise 307 | 308 | 309 | if __name__ == "__main__": 310 | main() 311 | -------------------------------------------------------------------------------- /lib/gitem/analytics.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | import collections 11 | 12 | from . import api 13 | 14 | 15 | def get_organization_information(ghapi, organization): 16 | organization_info, _ = ghapi.get_public_organization( 17 | organization 18 | ) 19 | 20 | api_name_to_human_readable_name = [ 21 | ('name', 'Organization Name'), 22 | ('description', 'Description'), 23 | ('blog', 'Website'), 24 | ('html_url', 'Github URL'), 25 | ('created_at', 'Created'), 26 | ('updated_at', 'Last Updated'), 27 | ('email', 'Email Address'), 28 | ('location', 'Location'), 29 | ('login', 'Username'), 30 | ('public_repos', '# of Public Repositories'), 31 | ] 32 | 33 | human_readable_name_to_api_info = collections.OrderedDict([ 34 | (human_readable_name, organization_info[api_name]) 35 | for api_name, human_readable_name in api_name_to_human_readable_name 36 | ]) 37 | 38 | return human_readable_name_to_api_info 39 | 40 | 41 | def get_organization_repositories(ghapi, organization): 42 | paged_organization_repositories = ghapi.get_organizations_public_repositories( 43 | organization 44 | ) 45 | 46 | api_name_to_human_readable_name = [ 47 | ('name', 'Repository Name'), 48 | ('description', 'Description'), 49 | ('html_url', 'Github URL'), 50 | ('clone_url', 'Clone URL'), 51 | ('watchers_count', 'Watchers'), 52 | ('stargazers_count', 'Stars'), 53 | ('forks_count', 'Forks'), 54 | ('created_at', 'Created'), 55 | ('updated_at', 'Last Updated'), 56 | ('pushed_at', 'Last Pushed'), 57 | ] 58 | 59 | human_readable_name_to_api_info = [ 60 | collections.OrderedDict([ 61 | (human_readable_name, organization_repository[api_name]) 62 | for api_name, human_readable_name in api_name_to_human_readable_name 63 | ]) 64 | for organization_repositories, _ in paged_organization_repositories 65 | for organization_repository in organization_repositories 66 | ] 67 | 68 | return human_readable_name_to_api_info 69 | 70 | 71 | def get_organization_members(ghapi, organization): 72 | paged_organization_members = ghapi.get_organizations_public_members( 73 | organization 74 | ) 75 | 76 | api_name_to_human_readable_name = [ 77 | ('login', 'Username'), 78 | ('site_admin', 'Site Administrator'), 79 | ('html_url', 'Github URL'), 80 | ] 81 | 82 | human_readable_name_to_api_info = [ 83 | collections.OrderedDict([ 84 | (human_readable_name, organization_member[api_name]) 85 | for api_name, human_readable_name in api_name_to_human_readable_name 86 | ]) 87 | for organization_members, _ in paged_organization_members 88 | for organization_member in organization_members 89 | ] 90 | 91 | return human_readable_name_to_api_info 92 | 93 | 94 | def get_repository_information(ghapi, owner, repository): 95 | repository_info, _ = ghapi.get_public_repository( 96 | owner, 97 | repository 98 | ) 99 | 100 | api_name_to_human_readable_name = [ 101 | ('name', 'Repository Name'), 102 | ('description', 'Description'), 103 | ('homepage', 'Homepage'), 104 | ('html_url', 'Github URL'), 105 | ('clone_url', 'Clone URL'), 106 | ('created_at', 'Created'), 107 | ('updated_at', 'Last Updated'), 108 | ('pushed_at', 'Last Pushed'), 109 | ('language', 'Language'), 110 | ('forks_count', 'Forks'), 111 | ('stargazers_count', 'Stars'), 112 | ('watchers_count', 'Watchers'), 113 | ] 114 | 115 | human_readable_name_to_api_info = collections.OrderedDict([ 116 | (human_readable_name, repository_info[api_name]) 117 | for api_name, human_readable_name in api_name_to_human_readable_name 118 | ]) 119 | 120 | return human_readable_name_to_api_info 121 | 122 | 123 | def get_repository_contributors(ghapi, owner, repository): 124 | paged_repository_contributors = ghapi.get_repository_contributors( 125 | owner, 126 | repository 127 | ) 128 | 129 | api_name_to_human_readable_name = [ 130 | ('login', 'Username'), 131 | ('contributions', 'Contributions'), 132 | ] 133 | 134 | human_readable_name_to_api_info = [ 135 | collections.OrderedDict([ 136 | (human_readable_name, repository_contributor[api_name]) 137 | for api_name, human_readable_name in api_name_to_human_readable_name 138 | ]) 139 | for repository_contributors, _ in paged_repository_contributors 140 | for repository_contributor in repository_contributors 141 | ] 142 | 143 | return human_readable_name_to_api_info 144 | 145 | 146 | def get_user_information(ghapi, username): 147 | user_info, _ = ghapi.get_user( 148 | username 149 | ) 150 | 151 | api_name_to_human_readable_name = [ 152 | ('login', 'Username'), 153 | ('html_url', 'Github URL'), 154 | ('name', 'Name'), 155 | ('company', 'Company'), 156 | ('blog', 'Blog'), 157 | ('location', 'Location'), 158 | ('email', 'Email Address'), 159 | ('created_at', 'Created'), 160 | ('updated_at', 'Updated'), 161 | ] 162 | 163 | human_readable_name_to_api_info = collections.OrderedDict([ 164 | (human_readable_name, user_info[api_name]) 165 | for api_name, human_readable_name in api_name_to_human_readable_name 166 | ]) 167 | 168 | return human_readable_name_to_api_info 169 | 170 | 171 | def get_user_organizations(ghapi, username): 172 | paged_user_organizations = ghapi.get_users_public_organizations( 173 | username 174 | ) 175 | 176 | api_name_to_human_readable_name = [ 177 | ('login', 'Organization'), 178 | ] 179 | 180 | human_readable_name_to_api_info = [ 181 | collections.OrderedDict([ 182 | (human_readable_name, user_organization[api_name]) 183 | for api_name, human_readable_name in api_name_to_human_readable_name 184 | ]) 185 | for user_organizations, _ in paged_user_organizations 186 | for user_organization in user_organizations 187 | ] 188 | 189 | return human_readable_name_to_api_info 190 | 191 | 192 | def get_user_repositories(ghapi, username): 193 | # TODO: Change this back to type_='all' and find a good way to grab 194 | # the correct repository owners 195 | paged_user_repositories = ghapi.get_users_public_repositories( 196 | username, 197 | type_='owner', 198 | sort='pushed', 199 | direction='desc', 200 | ) 201 | 202 | api_name_to_human_readable_name = [ 203 | ('name', 'Repository Name'), 204 | ('description', 'Description'), 205 | ('html_url', 'Github URL'), 206 | ('clone_url', 'Clone URL'), 207 | ] 208 | 209 | human_readable_name_to_api_info = [ 210 | collections.OrderedDict([ 211 | (human_readable_name, user_repository[api_name]) 212 | for api_name, human_readable_name in api_name_to_human_readable_name 213 | ]) 214 | for user_repositories, _ in paged_user_repositories 215 | for user_repository in user_repositories 216 | ] 217 | 218 | return human_readable_name_to_api_info 219 | 220 | 221 | def get_repository_commit_emails(ghapi, owner, repository, author=None): 222 | paged_repository_commits = ghapi.get_repository_commits( 223 | owner, 224 | repository, 225 | author=author 226 | ) 227 | 228 | # https://developer.github.com/v3/git/ 229 | def get_commits_or_empty(repository_commits): 230 | try: 231 | for repository_commit in repository_commits: 232 | yield repository_commit 233 | except api.ApiCallException as e: 234 | if e.conflict: 235 | yield ([], None) 236 | else: 237 | # Re-raise original exception 238 | raise 239 | 240 | repository_commit_emails = { 241 | ( 242 | repository_commit['commit']['author']['name'], 243 | repository_commit['commit']['author']['email'], 244 | ) 245 | for repository_commits, _ in get_commits_or_empty(paged_repository_commits) 246 | for repository_commit in repository_commits 247 | } 248 | 249 | return repository_commit_emails 250 | -------------------------------------------------------------------------------- /lib/gitem/api.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | import functools 11 | import json 12 | 13 | import requests 14 | 15 | 16 | class AuthenticationRequiredException(BaseException): 17 | pass 18 | 19 | 20 | class ApiCallException(BaseException): 21 | 22 | rate_limiting_url = 'https://developer.github.com/v3/#rate-limiting' 23 | 24 | def __init__(self, code, message): 25 | self.code = code 26 | self.message = message 27 | 28 | @property 29 | def bad_request(self): 30 | return self.code == requests.codes.BAD_REQUEST 31 | 32 | @property 33 | def unprocessable_entity(self): 34 | return self.code == requests.codes.UNPROCESSABLE_ENTITY 35 | 36 | @property 37 | def forbidden(self): 38 | return self.code == requests.codes.FORBIDDEN 39 | 40 | @property 41 | def unauthorized(self): 42 | return self.code == requests.codes.UNAUTHORIZED 43 | 44 | @property 45 | def conflict(self): 46 | return self.code == requests.codes.CONFLICT 47 | 48 | @property 49 | def not_found(self): 50 | return self.code == requests.codes.NOT_FOUND 51 | 52 | @property 53 | def rate_limiting(self): 54 | return ( 55 | self.forbidden 56 | and self.message.get('documentation_url') == self.rate_limiting_url 57 | ) 58 | 59 | def __str__(self): 60 | return "{}: {}".format(self.code, json.dumps(self.message)) 61 | 62 | 63 | def oauth2_required(func): 64 | @functools.wraps(func) 65 | def wrapper(*args, **kwargs): 66 | if not args or getattr(args[0], "oauth2_token", None) is None: 67 | raise AuthenticationRequiredException("Please include an OAuth2 token.") 68 | return func(*args, **kwargs) 69 | return wrapper 70 | 71 | 72 | class Api(object): 73 | 74 | BASE_URL = "https://api.github.com" 75 | 76 | def __init__(self, oauth2_token=None, requester=requests.request): 77 | self.oauth2_token = oauth2_token 78 | self.requester = requester 79 | 80 | # https://developer.github.com/v3/media/#request-specific-version 81 | self.headers = { 82 | "Accept": "application/vnd.github.v3+json", 83 | } 84 | 85 | def call(self, method, url, params=None): 86 | """ 87 | Make a Github developer API call 88 | """ 89 | if params is None: 90 | params = {} 91 | 92 | if self.oauth2_token: 93 | params["access_token"] = self.oauth2_token 94 | 95 | response = self.requester(method, url, params=params, headers=self.headers) 96 | 97 | if not response.ok: 98 | raise ApiCallException(response.status_code, response.json()) 99 | 100 | return response 101 | 102 | def json_call(self, method, endpoint, params=None): 103 | """ 104 | Return JSON data from a Github developer API call 105 | """ 106 | if params is None: 107 | params = {} 108 | 109 | url = self.BASE_URL + endpoint 110 | response = self.call(method, url, params) 111 | 112 | return (response.json(), response.status_code) 113 | 114 | def paginated_json_call(self, method, endpoint, params=None): 115 | """ 116 | Return paginated JSON data from a Github developer API call 117 | """ 118 | if params is None: 119 | params = {} 120 | 121 | url = self.BASE_URL + endpoint 122 | 123 | next_link = True 124 | while next_link: 125 | try: 126 | response = self.call(method, url, params) 127 | except StopIteration: 128 | # Handle PEP 479 129 | return 130 | 131 | yield (response.json(), response.status_code) 132 | next_link = response.links.get("next", {}) 133 | url = next_link.get("url") 134 | 135 | def get_user(self, username): 136 | """ 137 | Return user information associated with a given username 138 | 139 | https://developer.github.com/v3/users/#get-a-single-user 140 | """ 141 | method = "GET" 142 | endpoint = "/users/{}".format(username) 143 | params = {} 144 | 145 | result = self.json_call(method, endpoint, params) 146 | 147 | return result 148 | 149 | @oauth2_required 150 | def get_users_organizations(self): 151 | """ 152 | Return organizations associated with an OAuth2 authenticated user 153 | 154 | https://developer.github.com/v3/orgs/#list-your-organizations 155 | """ 156 | method = "GET" 157 | endpoint = "/user/orgs" 158 | params = {} 159 | 160 | result = self.json_call(method, endpoint, params) 161 | 162 | return result 163 | 164 | def get_users_public_organizations(self, username): 165 | """ 166 | Return public organizations associated with a user 167 | 168 | https://developer.github.com/v3/orgs/#list-user-organizations 169 | """ 170 | method = "GET" 171 | endpoint = "/users/{}/orgs".format(username) 172 | params = {} 173 | 174 | result = self.paginated_json_call(method, endpoint, params) 175 | 176 | return result 177 | 178 | def get_users_public_repositories(self, username, type_=None, sort=None, direction=None): 179 | """ 180 | Return public repositories associated with a given user 181 | 182 | https://developer.github.com/v3/repos/#list-user-repositories 183 | """ 184 | type_values = ["all", "owner", "member"] 185 | if type_ not in type_values and type_ is not None: 186 | raise ValueError("type must be one of {}".format(type_values)) 187 | 188 | sort_values = ["created", "updated", "pushed", "full_name"] 189 | if sort not in sort_values and sort is not None: 190 | raise ValueError("sort must be one of {}".format(sort_values)) 191 | 192 | direction_values = ["asc", "desc"] 193 | if direction not in direction_values and direction is not None: 194 | raise ValueError("direction must be one of {}".format(direction_values)) 195 | 196 | method = "GET" 197 | endpoint = "/users/{}/repos".format(username) 198 | params = {} 199 | 200 | if type_: 201 | params["type"] = type_ 202 | if sort: 203 | params["sort"] = sort 204 | if direction: 205 | params["direction"] = direction 206 | 207 | result = self.paginated_json_call(method, endpoint, params) 208 | 209 | return result 210 | 211 | def get_public_organization(self, organization): 212 | """ 213 | Return public information associated with an organization 214 | 215 | https://developer.github.com/v3/orgs/#get-an-organization 216 | """ 217 | method = "GET" 218 | endpoint = "/orgs/{}".format(organization) 219 | params = {} 220 | 221 | result = self.json_call(method, endpoint, params) 222 | 223 | return result 224 | 225 | @oauth2_required 226 | def get_organization(self, organization): 227 | """ 228 | Return information associated with an organization, OAuth2 229 | authenticated user must be an owner 230 | 231 | https://developer.github.com/v3/orgs/#get-an-organization 232 | """ 233 | return self.get_public_organization(organization) 234 | 235 | def get_organizations_public_repositories(self, organization, type_=None): 236 | """ 237 | Return public repositories associated with a given organization 238 | 239 | https://developer.github.com/v3/repos/#list-organization-repositories 240 | """ 241 | type_values = ["all", "public", "private", "forks", "sources", "member"] 242 | if type_ not in type_values and type_ is not None: 243 | raise ValueError("type must be one of {}".format(type_values)) 244 | 245 | method = "GET" 246 | endpoint = "/orgs/{}/repos".format(organization) 247 | params = {} 248 | 249 | if type_: 250 | params["type"] = type_ 251 | 252 | result = self.paginated_json_call(method, endpoint, params) 253 | 254 | return result 255 | 256 | def get_organizations_public_members(self, organization): 257 | """ 258 | Return public members associated with a given organization 259 | 260 | https://developer.github.com/v3/orgs/members/ 261 | """ 262 | method = "GET" 263 | endpoint = "/orgs/{}/public_members".format(organization) 264 | params = {} 265 | 266 | result = self.paginated_json_call(method, endpoint, params) 267 | 268 | return result 269 | 270 | def get_public_repository(self, owner, repository): 271 | """ 272 | Return public information associated with a repository 273 | 274 | https://developer.github.com/v3/repos/#get 275 | """ 276 | method = "GET" 277 | endpoint = "/repos/{}/{}".format(owner, repository) 278 | params = {} 279 | 280 | result = self.json_call(method, endpoint, params) 281 | 282 | return result 283 | 284 | def get_repository_contributors(self, owner, repository, anon=None): 285 | """ 286 | Return contributor information associated with a given repository 287 | 288 | https://developer.github.com/v3/repos/#list-contributors 289 | """ 290 | anon_values = [1, "true"] 291 | if anon not in anon_values and anon is not None: 292 | raise ValueError("anon must be one of {}".format(anon_values)) 293 | 294 | method = "GET" 295 | endpoint = "/repos/{}/{}/contributors".format(owner, repository) 296 | params = {} 297 | 298 | if anon: 299 | params["anon"] = anon 300 | 301 | result = self.paginated_json_call(method, endpoint, params) 302 | 303 | return result 304 | 305 | def get_repository_commits(self, owner, repository, sha=None, path=None, 306 | author=None, since=None, until=None): 307 | """ 308 | Return commit information associated with a given repository 309 | 310 | https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository 311 | """ 312 | method = "GET" 313 | endpoint = "/repos/{}/{}/commits".format(owner, repository) 314 | params = {} 315 | 316 | if sha: 317 | params["sha"] = sha 318 | if path: 319 | params["path"] = path 320 | if author: 321 | params["author"] = author 322 | if since: 323 | params["since"] = since 324 | if until: 325 | params["until"] = until 326 | 327 | result = self.paginated_json_call(method, endpoint, params) 328 | 329 | return result 330 | -------------------------------------------------------------------------------- /lib/gitem/output/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import ( 2 | absolute_import, 3 | division, 4 | print_function, 5 | unicode_literals, 6 | ) 7 | 8 | from .stdout import Stdout 9 | from .json import Json 10 | 11 | __all__ = [ 12 | 'Stdout', 13 | 'Json', 14 | ] 15 | -------------------------------------------------------------------------------- /lib/gitem/output/base.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | import abc 11 | import sys 12 | 13 | if sys.version_info >= (3, 4): 14 | ABC = abc.ABC 15 | else: 16 | ABC = abc.ABCMeta(str('ABC'), (), {}) 17 | 18 | 19 | class Base(ABC): 20 | 21 | name = "base" 22 | 23 | def __init__(self, file_=sys.stdout): 24 | self.file = file_ 25 | 26 | @abc.abstractmethod 27 | def output(self): 28 | pass 29 | -------------------------------------------------------------------------------- /lib/gitem/output/json.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | import json 11 | 12 | from . import base 13 | 14 | 15 | class Json(base.Base): 16 | 17 | name = "json" 18 | 19 | def output(self, data): 20 | output = json.dumps(data, separators=(",", ":")) 21 | 22 | print(output, file=self.file) 23 | -------------------------------------------------------------------------------- /lib/gitem/output/stdout.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import ( 4 | absolute_import, 5 | division, 6 | print_function, 7 | unicode_literals, 8 | ) 9 | 10 | from . import base 11 | 12 | 13 | class Stdout(base.Base): 14 | 15 | name = "stdout" 16 | depth_increment = 2 17 | 18 | def __init__(self, *args, **kwargs): 19 | self.first_recurse = True 20 | 21 | super(Stdout, self).__init__(*args, **kwargs) 22 | 23 | def output_helper(self, data, depth): 24 | for i, (key, value) in enumerate(data.items()): 25 | if isinstance(value, dict): 26 | if depth == 0 and i == 0 and self.first_recurse: 27 | # If we're on the very first dict then don't include an 28 | # awkward newline before we've printed anything else 29 | self.first_recurse = False 30 | else: 31 | print("", file=self.file) 32 | 33 | output = "{}:".format(key) 34 | print(" " * depth + output, file=self.file) 35 | 36 | self.output_helper(value, depth + self.depth_increment) 37 | elif isinstance(value, list): 38 | output = "{}:".format(key) 39 | print(" " * depth + output, file=self.file) 40 | 41 | for l in value: 42 | print(" " * (depth + self.depth_increment) + l, file=self.file) 43 | else: 44 | if value == "": 45 | output = "{}:".format(key) 46 | else: 47 | output = "{}: {}".format(key, value) 48 | 49 | print(" " * depth + output, file=self.file) 50 | 51 | def output(self, data): 52 | self.output_helper(data, 0) 53 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | pytest==4.6.5 2 | pytest-cov==2.8.1 3 | flake8==3.7.9 4 | coveralls==1.8.2 5 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.20.0 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [bdist_wheel] 2 | universal = 1 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import ( 2 | find_packages, 3 | setup, 4 | ) 5 | 6 | import os 7 | import sys 8 | 9 | PACKAGE_DIRECTORY = 'lib' 10 | 11 | sys.path.append(PACKAGE_DIRECTORY) 12 | 13 | import gitem 14 | 15 | requirements_filename = os.path.join( 16 | os.path.dirname(os.path.abspath(__file__)), 'requirements.txt') 17 | 18 | with open(requirements_filename) as fd: 19 | install_requires = [i.strip() for i in fd.readlines()] 20 | 21 | requirements_dev_filename = os.path.join( 22 | os.path.dirname(os.path.abspath(__file__)), 'requirements-dev.txt') 23 | 24 | with open(requirements_dev_filename) as fd: 25 | tests_require = [i.strip() for i in fd.readlines()] 26 | 27 | long_description_filename = os.path.join( 28 | os.path.dirname(os.path.abspath(__file__)), 'README.md') 29 | 30 | with open(long_description_filename) as fd: 31 | long_description = fd.read() 32 | 33 | setup( 34 | name=gitem.__name__, 35 | version=gitem.__version__, 36 | description='A Github organization reconnaissance tool.', 37 | long_description=long_description, 38 | long_description_content_type='text/markdown', 39 | url='https://github.com/mschwager/gitem', 40 | packages=find_packages(where=PACKAGE_DIRECTORY), 41 | package_dir={'': PACKAGE_DIRECTORY}, 42 | license='GPLv3', 43 | classifiers=[ 44 | 'Environment :: Console', 45 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 46 | 'Operating System :: MacOS :: MacOS X', 47 | 'Operating System :: Microsoft :: Windows', 48 | 'Operating System :: POSIX', 49 | 'Programming Language :: Python :: 2.7', 50 | 'Programming Language :: Python :: 3.5', 51 | 'Programming Language :: Python :: 3.6', 52 | 'Programming Language :: Python :: 3.7', 53 | 'Programming Language :: Python :: 3.8', 54 | ], 55 | install_requires=install_requires, 56 | tests_require=tests_require, 57 | entry_points={ 58 | 'console_scripts': [ 59 | 'gitem = gitem.__main__:main', 60 | ], 61 | }, 62 | ) 63 | -------------------------------------------------------------------------------- /tests/mocked_api_results.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import requests 4 | 5 | STANDARD_API_RESULT = [ 6 | { 7 | "api results": "go here", 8 | }, 9 | requests.codes.OK, 10 | ] 11 | 12 | PAGED_API_RESULT = [ 13 | STANDARD_API_RESULT, 14 | STANDARD_API_RESULT, 15 | STANDARD_API_RESULT, 16 | ] 17 | 18 | INVALID_JSON_RESULT = [ 19 | { 20 | "message": "Problems parsing JSON", 21 | }, 22 | requests.codes.BAD_REQUEST, 23 | ] 24 | 25 | BAD_JSON_VALUES_RESULT = [ 26 | { 27 | "message": "Body should be a JSON object", 28 | }, 29 | requests.codes.BAD_REQUEST, 30 | ] 31 | 32 | INVALID_FIELDS_RESULT = [ 33 | { 34 | "message": "Validation Failed", 35 | "errors": [ 36 | { 37 | "resource": "Issue", 38 | "field": "title", 39 | "code": "missing_field", 40 | } 41 | ], 42 | }, 43 | requests.codes.UNPROCESSABLE_ENTITY, 44 | ] 45 | 46 | BAD_CREDENTIALS_RESULT = [ 47 | { 48 | "message": "Bad credentials", 49 | "documentation_url": "https://developer.github.com/v3", 50 | }, 51 | requests.codes.UNAUTHORIZED, 52 | ] 53 | 54 | MAXIMUM_BAD_CREDENTIALS_RESULT = [ 55 | { 56 | "message": "Maximum number of login attempts exceeded. Please try again later.", 57 | "documentation_url": "https://developer.github.com/v3", 58 | }, 59 | requests.codes.FORBIDDEN, 60 | ] 61 | 62 | NOT_FOUND_RESULT = [ 63 | { 64 | "message": "Not Found", 65 | "documentation_url": "https://developer.github.com/v3", 66 | }, 67 | requests.codes.NOT_FOUND, 68 | ] 69 | 70 | 71 | def get_result_value(result): 72 | return result[0] 73 | 74 | 75 | def get_result_status_code(result): 76 | return result[1] 77 | -------------------------------------------------------------------------------- /tests/test_analytics.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import collections 4 | import unittest 5 | 6 | try: 7 | # Python 3 8 | from unittest import mock 9 | except ImportError: 10 | # Python 2 (third-party) 11 | import mock 12 | 13 | import requests 14 | import pytest 15 | 16 | from gitem import analytics 17 | from gitem import api 18 | 19 | 20 | class TestAnalytics(unittest.TestCase): 21 | 22 | def test_get_organization_information(self): 23 | return_value = ( 24 | { 25 | 'name': 'name1', 26 | 'description': 'desc1', 27 | 'blog': 'blog1', 28 | 'html_url': 'hu1', 29 | 'created_at': 'ca1', 30 | 'updated_at': 'ua1', 31 | 'email': 'email1', 32 | 'location': 'loc1', 33 | 'login': 'test1', 34 | 'public_repos': 'pr1', 35 | }, 36 | requests.codes.OK, 37 | ) 38 | 39 | ghapi = mock.MagicMock() 40 | ghapi.get_public_organization = mock.MagicMock( 41 | return_value=return_value 42 | ) 43 | 44 | result = analytics.get_organization_information(ghapi, "unused") 45 | 46 | expected = collections.OrderedDict([ 47 | ('Organization Name', 'name1'), 48 | ('Description', 'desc1'), 49 | ('Website', 'blog1'), 50 | ('Github URL', 'hu1'), 51 | ('Created', 'ca1'), 52 | ('Last Updated', 'ua1'), 53 | ('Email Address', 'email1'), 54 | ('Location', 'loc1'), 55 | ('Username', 'test1'), 56 | ('# of Public Repositories', 'pr1'), 57 | ]) 58 | 59 | assert result == expected 60 | 61 | def test_get_organization_repositories(self): 62 | return_value = [ 63 | ( 64 | [{ 65 | 'name': 'name1', 66 | 'description': 'desc1', 67 | 'html_url': 'hu1', 68 | 'clone_url': 'cu1', 69 | 'watchers_count': 'wc1', 70 | 'stargazers_count': 'sc1', 71 | 'forks_count': 'fc1', 72 | 'created_at': 'ca1', 73 | 'updated_at': 'ua1', 74 | 'pushed_at': 'pa1', 75 | }], 76 | requests.codes.OK, 77 | ), 78 | ] 79 | 80 | ghapi = mock.MagicMock() 81 | ghapi.get_organizations_public_repositories = mock.MagicMock( 82 | return_value=return_value 83 | ) 84 | 85 | result = analytics.get_organization_repositories(ghapi, "unused") 86 | 87 | expected = [ 88 | collections.OrderedDict([ 89 | ('Repository Name', 'name1'), 90 | ('Description', 'desc1'), 91 | ('Github URL', 'hu1'), 92 | ('Clone URL', 'cu1'), 93 | ('Watchers', 'wc1'), 94 | ('Stars', 'sc1'), 95 | ('Forks', 'fc1'), 96 | ('Created', 'ca1'), 97 | ('Last Updated', 'ua1'), 98 | ('Last Pushed', 'pa1'), 99 | ]), 100 | ] 101 | 102 | assert result == expected 103 | 104 | def test_get_organization_members(self): 105 | return_value = [ 106 | ( 107 | [{ 108 | 'login': 'test1', 109 | 'site_admin': 'sa1', 110 | 'html_url': 'hu1', 111 | }], 112 | requests.codes.OK, 113 | ), 114 | ( 115 | [{ 116 | 'login': 'test2', 117 | 'site_admin': 'sa2', 118 | 'html_url': 'hu2', 119 | }], 120 | requests.codes.OK, 121 | ), 122 | ] 123 | 124 | ghapi = mock.MagicMock() 125 | ghapi.get_organizations_public_members = mock.MagicMock( 126 | return_value=return_value 127 | ) 128 | 129 | result = analytics.get_organization_members(ghapi, "unused") 130 | 131 | expected = [ 132 | collections.OrderedDict([ 133 | ('Username', 'test1'), 134 | ('Site Administrator', 'sa1'), 135 | ('Github URL', 'hu1'), 136 | ]), 137 | collections.OrderedDict([ 138 | ('Username', 'test2'), 139 | ('Site Administrator', 'sa2'), 140 | ('Github URL', 'hu2'), 141 | ]), 142 | ] 143 | 144 | assert result == expected 145 | 146 | def test_get_repository_information(self): 147 | return_value = ( 148 | { 149 | 'name': 'name1', 150 | 'description': 'desc1', 151 | 'homepage': 'home1', 152 | 'html_url': 'hu1', 153 | 'clone_url': 'cu1', 154 | 'created_at': 'ca1', 155 | 'updated_at': 'ua1', 156 | 'pushed_at': 'pa1', 157 | 'language': 'lang1', 158 | 'forks_count': 'fc1', 159 | 'stargazers_count': 'sc1', 160 | 'watchers_count': 'wc1', 161 | }, 162 | requests.codes.OK, 163 | ) 164 | 165 | ghapi = mock.MagicMock() 166 | ghapi.get_public_repository = mock.MagicMock( 167 | return_value=return_value 168 | ) 169 | 170 | result = analytics.get_repository_information(ghapi, "unused", "unused") 171 | 172 | expected = collections.OrderedDict([ 173 | ('Repository Name', 'name1'), 174 | ('Description', 'desc1'), 175 | ('Homepage', 'home1'), 176 | ('Github URL', 'hu1'), 177 | ('Clone URL', 'cu1'), 178 | ('Created', 'ca1'), 179 | ('Last Updated', 'ua1'), 180 | ('Last Pushed', 'pa1'), 181 | ('Language', 'lang1'), 182 | ('Forks', 'fc1'), 183 | ('Stars', 'sc1'), 184 | ('Watchers', 'wc1'), 185 | ]) 186 | 187 | assert result == expected 188 | 189 | def test_get_repository_contributors(self): 190 | return_value = [ 191 | ( 192 | [{ 193 | 'login': 'test1', 194 | 'contributions': 'cont1' 195 | }], 196 | requests.codes.OK 197 | ), 198 | ( 199 | [{ 200 | 'login': 'test2', 201 | 'contributions': 'cont2' 202 | }], 203 | requests.codes.OK 204 | ), 205 | ] 206 | 207 | ghapi = mock.MagicMock() 208 | ghapi.get_repository_contributors = mock.MagicMock( 209 | return_value=return_value 210 | ) 211 | 212 | result = analytics.get_repository_contributors(ghapi, "unused", "unused") 213 | 214 | expected = [ 215 | collections.OrderedDict([ 216 | ('Username', 'test1'), 217 | ('Contributions', 'cont1'), 218 | ]), 219 | collections.OrderedDict([ 220 | ('Username', 'test2'), 221 | ('Contributions', 'cont2'), 222 | ]), 223 | ] 224 | 225 | assert result == expected 226 | 227 | def test_get_user_information(self): 228 | return_value = ( 229 | { 230 | 'login': 'username1', 231 | 'html_url': 'hu1', 232 | 'name': 'name1', 233 | 'company': 'co1', 234 | 'blog': 'blog1', 235 | 'location': 'loc1', 236 | 'email': 'email1', 237 | 'created_at': 'ca1', 238 | 'updated_at': 'ua1', 239 | }, 240 | requests.codes.OK, 241 | ) 242 | 243 | ghapi = mock.MagicMock() 244 | ghapi.get_user = mock.MagicMock( 245 | return_value=return_value 246 | ) 247 | 248 | result = analytics.get_user_information(ghapi, "unused") 249 | 250 | expected = collections.OrderedDict([ 251 | ('Username', 'username1'), 252 | ('Github URL', 'hu1'), 253 | ('Name', 'name1'), 254 | ('Company', 'co1'), 255 | ('Blog', 'blog1'), 256 | ('Location', 'loc1'), 257 | ('Email Address', 'email1'), 258 | ('Created', 'ca1'), 259 | ('Updated', 'ua1'), 260 | ]) 261 | 262 | assert result == expected 263 | 264 | def test_get_user_organization(self): 265 | return_value = [ 266 | ( 267 | [{ 268 | 'login': 'test1' 269 | }], 270 | requests.codes.OK 271 | ), 272 | ( 273 | [{ 274 | 'login': 'test2' 275 | }], 276 | requests.codes.OK 277 | ), 278 | ] 279 | 280 | ghapi = mock.MagicMock() 281 | ghapi.get_users_public_organizations = mock.MagicMock( 282 | return_value=return_value 283 | ) 284 | 285 | result = analytics.get_user_organizations(ghapi, "unused") 286 | 287 | expected = [ 288 | collections.OrderedDict([ 289 | ('Organization', 'test1'), 290 | ]), 291 | collections.OrderedDict([ 292 | ('Organization', 'test2'), 293 | ]), 294 | ] 295 | 296 | assert result == expected 297 | 298 | def test_get_user_repositories(self): 299 | return_value = [ 300 | ( 301 | [{ 302 | 'name': 'name1', 303 | 'description': 'desc1', 304 | 'html_url': 'hu1', 305 | 'clone_url': 'cu1', 306 | }], 307 | requests.codes.OK, 308 | ) 309 | ] 310 | 311 | ghapi = mock.MagicMock() 312 | ghapi.get_users_public_repositories = mock.MagicMock( 313 | return_value=return_value 314 | ) 315 | 316 | result = analytics.get_user_repositories(ghapi, "unused") 317 | 318 | expected = [ 319 | collections.OrderedDict([ 320 | ('Repository Name', 'name1'), 321 | ('Description', 'desc1'), 322 | ('Github URL', 'hu1'), 323 | ('Clone URL', 'cu1'), 324 | ]) 325 | ] 326 | 327 | assert result == expected 328 | 329 | def test_get_repository_commit_emails_basic(self): 330 | return_value = [ 331 | ( 332 | [{ 333 | 'commit': { 334 | 'author': { 335 | 'name': 'username1', 336 | 'email': 'email1', 337 | }, 338 | }, 339 | }], 340 | requests.codes.OK, 341 | ) 342 | ] 343 | 344 | ghapi = mock.MagicMock() 345 | ghapi.get_repository_commits = mock.MagicMock( 346 | return_value=return_value 347 | ) 348 | 349 | result = analytics.get_repository_commit_emails(ghapi, "unused", "unused") 350 | 351 | expected = {('username1', 'email1')} 352 | 353 | assert result == expected 354 | 355 | def test_get_repository_commit_emails_conflict(self): 356 | def conflict_generator(): 357 | raise api.ApiCallException(requests.codes.CONFLICT, "unused") 358 | yield # Empty yield to make this a generator 359 | 360 | return_value = conflict_generator() 361 | 362 | ghapi = mock.MagicMock() 363 | ghapi.get_repository_commits = mock.MagicMock( 364 | return_value=return_value 365 | ) 366 | 367 | result = analytics.get_repository_commit_emails(ghapi, "unused", "unused") 368 | 369 | expected = set() 370 | 371 | assert result == expected 372 | 373 | def test_get_repository_commit_emails_not_conflict(self): 374 | def not_conflict_generator(): 375 | raise api.ApiCallException(requests.codes.BAD_REQUEST, "unused") 376 | yield # Empty yield to make this a generator 377 | 378 | return_value = not_conflict_generator() 379 | 380 | ghapi = mock.MagicMock() 381 | ghapi.get_repository_commits = mock.MagicMock( 382 | return_value=return_value 383 | ) 384 | 385 | with pytest.raises(api.ApiCallException): 386 | analytics.get_repository_commit_emails(ghapi, "unused", "unused") 387 | 388 | 389 | if __name__ == "__main__": 390 | unittest.main() 391 | -------------------------------------------------------------------------------- /tests/test_api.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import unittest 4 | 5 | try: 6 | # Python 3 7 | from unittest import mock 8 | except ImportError: 9 | # Python 2 (third-party) 10 | import mock 11 | 12 | import requests 13 | import pytest 14 | 15 | from gitem import api 16 | 17 | import mocked_api_results 18 | 19 | 20 | class TestApi(unittest.TestCase): 21 | 22 | def assertOk(self, status_code): 23 | assert status_code == requests.codes.OK 24 | 25 | def assertEmpty(self, iterable): 26 | assert len(iterable) == 0 27 | 28 | @staticmethod 29 | def api_will_return(json_return_value, status_code=requests.codes.OK, oauth2_token=None): 30 | assert isinstance(json_return_value, dict) 31 | 32 | return_value = mock.MagicMock() 33 | 34 | return_value.status_code = status_code 35 | return_value.json = mock.MagicMock( 36 | return_value=json_return_value 37 | ) 38 | return_value.ok = status_code == requests.codes.OK 39 | 40 | return api.Api(oauth2_token, requester=mock.MagicMock( 41 | return_value=return_value 42 | )) 43 | 44 | @staticmethod 45 | def paged_api_will_return(json_return_values, status_codes=None, oauth2_token=None): 46 | assert isinstance(json_return_values, list) 47 | assert isinstance(status_codes, list) or status_codes is None 48 | 49 | if status_codes is None: 50 | status_codes = [requests.codes.OK] * len(json_return_values) 51 | 52 | return_value = mock.MagicMock() 53 | 54 | # This is some weird mock black magic... 55 | type(return_value).status_code = mock.PropertyMock( 56 | side_effect=status_codes 57 | ) 58 | return_value.json = mock.Mock( 59 | side_effect=json_return_values 60 | ) 61 | type(return_value).ok = mock.PropertyMock( 62 | side_effect=[ 63 | status_code == requests.codes.OK 64 | for status_code in status_codes 65 | ] 66 | ) 67 | 68 | return api.Api(oauth2_token, requester=mock.MagicMock( 69 | return_value=return_value 70 | )) 71 | 72 | def test_ok(self): 73 | will_return = mocked_api_results.STANDARD_API_RESULT 74 | 75 | mocked_api = self.api_will_return(*will_return) 76 | 77 | # The API call we make doesn't matter, it will return the same result 78 | # no matter what 79 | result, status_code = mocked_api.get_public_organization("unused") 80 | 81 | expected = mocked_api_results.get_result_value( 82 | mocked_api_results.STANDARD_API_RESULT 83 | ) 84 | 85 | self.assertOk(status_code) 86 | assert result == expected 87 | 88 | def test_invalid_json(self): 89 | will_return = mocked_api_results.INVALID_JSON_RESULT 90 | 91 | mocked_api = self.api_will_return(*will_return) 92 | 93 | # The API call we make doesn't matter, it will return the same result 94 | # no matter what 95 | with pytest.raises(api.ApiCallException) as e: 96 | mocked_api.get_public_organization("unused") 97 | 98 | assert e.value.bad_request 99 | 100 | def test_invalid_json_argument_type(self): 101 | will_return = mocked_api_results.BAD_JSON_VALUES_RESULT 102 | 103 | mocked_api = self.api_will_return(*will_return) 104 | 105 | # The API call we make doesn't matter, it will return the same result 106 | # no matter what 107 | with pytest.raises(api.ApiCallException) as e: 108 | mocked_api.get_public_organization("unused") 109 | 110 | assert e.value.bad_request 111 | 112 | def test_invalid_json_field(self): 113 | will_return = mocked_api_results.INVALID_FIELDS_RESULT 114 | 115 | mocked_api = self.api_will_return(*will_return) 116 | 117 | # The API call we make doesn't matter, it will return the same result 118 | # no matter what 119 | with pytest.raises(api.ApiCallException) as e: 120 | mocked_api.get_public_organization("unused") 121 | 122 | assert e.value.unprocessable_entity 123 | 124 | def test_bad_credentials(self): 125 | will_return = mocked_api_results.BAD_CREDENTIALS_RESULT 126 | 127 | mocked_api = self.api_will_return(*will_return) 128 | 129 | # The API call we make doesn't matter, it will return the same result 130 | # no matter what 131 | with pytest.raises(api.ApiCallException) as e: 132 | mocked_api.get_public_organization("unused") 133 | 134 | assert e.value.unauthorized 135 | 136 | def test_maximum_bad_credentials(self): 137 | will_return = mocked_api_results.MAXIMUM_BAD_CREDENTIALS_RESULT 138 | 139 | mocked_api = self.api_will_return(*will_return) 140 | 141 | # The API call we make doesn't matter, it will return the same result 142 | # no matter what 143 | with pytest.raises(api.ApiCallException) as e: 144 | mocked_api.get_public_organization("unused") 145 | 146 | assert e.value.forbidden 147 | 148 | def test_not_found(self): 149 | will_return = mocked_api_results.NOT_FOUND_RESULT 150 | 151 | mocked_api = self.api_will_return(*will_return) 152 | 153 | # The API call we make doesn't matter, it will return the same result 154 | # no matter what 155 | with pytest.raises(api.ApiCallException) as e: 156 | mocked_api.get_public_organization("unused") 157 | 158 | assert e.value.not_found 159 | 160 | def test_authenticated_endpoint_ok(self): 161 | will_return = mocked_api_results.STANDARD_API_RESULT 162 | 163 | mocked_api = self.api_will_return( 164 | *will_return, 165 | oauth2_token="VALUE DOESN'T MATTER" 166 | ) 167 | 168 | result, status_code = mocked_api.get_organization("unused") 169 | 170 | expected = mocked_api_results.get_result_value( 171 | mocked_api_results.STANDARD_API_RESULT 172 | ) 173 | 174 | self.assertOk(status_code) 175 | assert result == expected 176 | 177 | def test_authenticated_endpoint_missing_token(self): 178 | will_return = mocked_api_results.STANDARD_API_RESULT 179 | 180 | mocked_api = self.api_will_return( 181 | *will_return, 182 | oauth2_token=None 183 | ) 184 | 185 | with pytest.raises(api.AuthenticationRequiredException): 186 | mocked_api.get_organization("unused") 187 | 188 | def test_paged_ok(self): 189 | mocked_json_values = [ 190 | mocked_api_results.get_result_value(result) 191 | for result in mocked_api_results.PAGED_API_RESULT 192 | ] 193 | 194 | mocked_status_codes = [ 195 | mocked_api_results.get_result_status_code(result) 196 | for result in mocked_api_results.PAGED_API_RESULT 197 | ] 198 | 199 | mocked_api = self.paged_api_will_return(mocked_json_values, mocked_status_codes) 200 | 201 | for result, status_code in mocked_api.get_organizations_public_repositories("unused"): 202 | expected = mocked_api_results.get_result_value( 203 | mocked_api_results.STANDARD_API_RESULT 204 | ) 205 | 206 | self.assertOk(status_code) 207 | assert result == expected 208 | 209 | def test_paged_pep_479(self): 210 | mocked_json_values = [ 211 | mocked_api_results.get_result_value(result) 212 | for result in mocked_api_results.PAGED_API_RESULT 213 | ] 214 | mocked_json_values = [mocked_json_values[0]] 215 | 216 | mocked_api = self.paged_api_will_return(mocked_json_values) 217 | mocked_api.requester.return_value.ok = mock.PropertyMock( 218 | side_effect=StopIteration 219 | ) 220 | 221 | result = list(mocked_api.get_organizations_public_repositories("unused")) 222 | 223 | self.assertEmpty(result) 224 | 225 | def test_get_users_public_repositories_bad_type(self): 226 | type_ = "" 227 | ghapi = api.Api() 228 | 229 | with pytest.raises(ValueError): 230 | ghapi.get_users_public_repositories("UNUSED", type_=type_) 231 | 232 | def test_get_users_public_repositories_bad_sort(self): 233 | sort = "" 234 | ghapi = api.Api() 235 | 236 | with pytest.raises(ValueError): 237 | ghapi.get_users_public_repositories("UNUSED", sort=sort) 238 | 239 | def test_get_users_public_repositories_bad_direction(self): 240 | direction = "" 241 | ghapi = api.Api() 242 | 243 | with pytest.raises(ValueError): 244 | ghapi.get_users_public_repositories("UNUSED", direction=direction) 245 | 246 | def test_get_organizations_public_repositories_bad_type(self): 247 | type_ = "" 248 | ghapi = api.Api() 249 | 250 | with pytest.raises(ValueError): 251 | ghapi.get_organizations_public_repositories("UNUSED", type_=type_) 252 | 253 | def test_get_repository_contributors_bad_anon(self): 254 | anon = "" 255 | ghapi = api.Api() 256 | 257 | with pytest.raises(ValueError): 258 | ghapi.get_repository_contributors("UNUSED", "UNUSED", anon=anon) 259 | 260 | def test_get_repository_contributors_ok(self): 261 | mocked_json_values = [ 262 | mocked_api_results.get_result_value(result) 263 | for result in mocked_api_results.PAGED_API_RESULT 264 | ] 265 | 266 | mocked_status_codes = [ 267 | mocked_api_results.get_result_status_code(result) 268 | for result in mocked_api_results.PAGED_API_RESULT 269 | ] 270 | 271 | mocked_api = self.paged_api_will_return(mocked_json_values, mocked_status_codes) 272 | 273 | for result, status_code in mocked_api.get_repository_contributors("unused", "unused"): 274 | expected = mocked_api_results.get_result_value( 275 | mocked_api_results.STANDARD_API_RESULT 276 | ) 277 | 278 | self.assertOk(status_code) 279 | assert result == expected 280 | 281 | 282 | if __name__ == "__main__": 283 | unittest.main() 284 | -------------------------------------------------------------------------------- /tests/test_output/test_json.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import collections 4 | import io 5 | import textwrap 6 | import unittest 7 | 8 | from gitem import output 9 | 10 | 11 | class TestJson(unittest.TestCase): 12 | 13 | @staticmethod 14 | def dedent_helper(s): 15 | return textwrap.dedent(s).lstrip() 16 | 17 | def test_basic(self): 18 | data = collections.OrderedDict([ 19 | ('key', 'value'), 20 | ]) 21 | 22 | with io.StringIO() as stream: 23 | outputter = output.Json(file_=stream) 24 | outputter.output(data) 25 | result = stream.getvalue() 26 | 27 | expected = self.dedent_helper(''' 28 | {"key":"value"} 29 | ''') 30 | 31 | assert result == expected 32 | 33 | def test_list(self): 34 | data = collections.OrderedDict([ 35 | ('key1', collections.OrderedDict([ 36 | ('key2', ['value1', 'value2']), 37 | ])), 38 | ]) 39 | 40 | with io.StringIO() as stream: 41 | outputter = output.Json(file_=stream) 42 | outputter.output(data) 43 | result = stream.getvalue() 44 | 45 | expected = self.dedent_helper(''' 46 | {"key1":{"key2":["value1","value2"]}} 47 | ''') 48 | 49 | assert result == expected 50 | 51 | def test_recurse(self): 52 | data = collections.OrderedDict([ 53 | ('key1', 'value1'), 54 | ('key2', collections.OrderedDict([ 55 | ('key3', 'value2'), 56 | ])), 57 | ]) 58 | 59 | with io.StringIO() as stream: 60 | outputter = output.Json(file_=stream) 61 | outputter.output(data) 62 | result = stream.getvalue() 63 | 64 | expected = self.dedent_helper(''' 65 | {"key1":"value1","key2":{"key3":"value2"}} 66 | ''') 67 | 68 | assert result == expected 69 | 70 | def test_multi(self): 71 | data1 = collections.OrderedDict([ 72 | ('key1', 'value1'), 73 | ]) 74 | data2 = collections.OrderedDict([ 75 | ('key2', 'value2'), 76 | ]) 77 | 78 | with io.StringIO() as stream: 79 | outputter = output.Json(file_=stream) 80 | outputter.output(data1) 81 | outputter.output(data2) 82 | result = stream.getvalue() 83 | 84 | expected = self.dedent_helper(''' 85 | {"key1":"value1"} 86 | {"key2":"value2"} 87 | ''') 88 | 89 | assert result == expected 90 | 91 | 92 | if __name__ == "__main__": 93 | unittest.main() 94 | -------------------------------------------------------------------------------- /tests/test_output/test_stdout.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import collections 4 | import io 5 | import textwrap 6 | import unittest 7 | 8 | from gitem import output 9 | 10 | 11 | class TestStdout(unittest.TestCase): 12 | 13 | @staticmethod 14 | def dedent_helper(s): 15 | return textwrap.dedent(s).lstrip() 16 | 17 | def test_basic(self): 18 | data = collections.OrderedDict([ 19 | ('key', 'value'), 20 | ]) 21 | 22 | with io.StringIO() as stream: 23 | outputter = output.Stdout(file_=stream) 24 | outputter.output(data) 25 | result = stream.getvalue() 26 | 27 | expected = self.dedent_helper(''' 28 | key: value 29 | ''') 30 | 31 | assert result == expected 32 | 33 | def test_list(self): 34 | data = collections.OrderedDict([ 35 | ('key1', collections.OrderedDict([ 36 | ('key2', ['value1', 'value2']), 37 | ])), 38 | ]) 39 | 40 | with io.StringIO() as stream: 41 | outputter = output.Stdout(file_=stream) 42 | outputter.output(data) 43 | result = stream.getvalue() 44 | 45 | expected = self.dedent_helper(''' 46 | key1: 47 | key2: 48 | value1 49 | value2 50 | ''') 51 | 52 | assert result == expected 53 | 54 | def test_recurse(self): 55 | data = collections.OrderedDict([ 56 | ('key1', 'value1'), 57 | ('key2', collections.OrderedDict([ 58 | ('key3', 'value2'), 59 | ])), 60 | ]) 61 | 62 | with io.StringIO() as stream: 63 | outputter = output.Stdout(file_=stream) 64 | outputter.output(data) 65 | result = stream.getvalue() 66 | 67 | expected = self.dedent_helper(''' 68 | key1: value1 69 | 70 | key2: 71 | key3: value2 72 | ''') 73 | 74 | assert result == expected 75 | 76 | def test_newline(self): 77 | data = collections.OrderedDict([ 78 | ('key1', 'value1'), 79 | ('key2', collections.OrderedDict([ 80 | ('key3', 'value2'), 81 | ])), 82 | ('key4', collections.OrderedDict([ 83 | ('key5', 'value3'), 84 | ])), 85 | ]) 86 | 87 | with io.StringIO() as stream: 88 | outputter = output.Stdout(file_=stream) 89 | outputter.output(data) 90 | result = stream.getvalue() 91 | 92 | expected = self.dedent_helper(''' 93 | key1: value1 94 | 95 | key2: 96 | key3: value2 97 | 98 | key4: 99 | key5: value3 100 | ''') 101 | 102 | assert result == expected 103 | 104 | def test_multi(self): 105 | data1 = collections.OrderedDict([ 106 | ('key1', 'value1'), 107 | ]) 108 | data2 = collections.OrderedDict([ 109 | ('key2', 'value2'), 110 | ]) 111 | 112 | with io.StringIO() as stream: 113 | outputter = output.Stdout(file_=stream) 114 | outputter.output(data1) 115 | outputter.output(data2) 116 | result = stream.getvalue() 117 | 118 | expected = self.dedent_helper(''' 119 | key1: value1 120 | key2: value2 121 | ''') 122 | 123 | assert result == expected 124 | 125 | 126 | if __name__ == "__main__": 127 | unittest.main() 128 | --------------------------------------------------------------------------------