mirror of
https://github.com/jcreek/Assassins-Mission-Control.git
synced 2026-07-12 18:43:43 +00:00
Committing the current version
This version works and has been tested in a full game with over 50 players however there isn’t as yet a proper admin backend and many activities require the admin to fiddle with html or SQL at the moment.
This commit is contained in:
@@ -0,0 +1,72 @@
|
||||
codebird-js - changelog
|
||||
=======================
|
||||
|
||||
2.5.0-alpha.1.1 (2014-01-02)
|
||||
+ #24 Add README section about xAuth
|
||||
+ #46 Don't force to send base64 media uploads via proxy
|
||||
+ #23 Support internal API methods
|
||||
+ #50 Current rate sent back with each call
|
||||
+ Support custom timelines beta API
|
||||
- Remove POST geo/place API method, deprecated
|
||||
+ #52 Don't use proxy for non-browser environments
|
||||
- #49 Places & Geo API call issue
|
||||
+ #53 Support AMD module definition syntax
|
||||
+ #54 Integrate sha1 hash library
|
||||
+ Add NPM package.json
|
||||
|
||||
2.4.3 (2013-07-24)
|
||||
- #31 HTTP error on multiple oauth_requestToken calls
|
||||
- #30 HTML-escaping typo in readme code sample
|
||||
|
||||
2.4.2 (2013-07-09)
|
||||
- #21 Typo extra bracket in readme sample code
|
||||
- #27 Array bad behavior in iOS
|
||||
|
||||
2.4.1 (2013-06-23)
|
||||
+ Pass JSHint validation
|
||||
+ #15 Allow to assign custom proxy address
|
||||
- #19 API parameters with escaped characters fail in IE7-9
|
||||
|
||||
2.4.0 (2013-06-15)
|
||||
+ Support multipart file uploads
|
||||
- Drop unnecessary media format settings ported from PHP getimagesize
|
||||
- Don't unintendedly overwrite global "url" variable
|
||||
+ Add contributing guidelines
|
||||
|
||||
2.3.3 (2013-05-31)
|
||||
- oauth2_token doesn't respect _useProxy CORS setting
|
||||
- #10 setBearerToken was not public
|
||||
|
||||
2.3.2 (2013-05-21)
|
||||
- Sorting the OAuth parameter list in IE incorrectly
|
||||
- Undefined function c for debug logging
|
||||
+ Correctly detect templated methods and insert their parameters
|
||||
|
||||
2.3.1 (2013-04-26)
|
||||
- Wrong OAuth signature generation for POST requests with oauth_callback
|
||||
- Wrong _ksort implementation
|
||||
|
||||
2.3.0 (2013-04-26)
|
||||
- Bug in _detectMultipart for statuses/update calls
|
||||
+ Add Array.indexOf polyfill
|
||||
+ Circumvent same-origin policy with CORS
|
||||
+ Make oauth_authenticate and oauth_authorize asynchronous
|
||||
+ Send GET requests via JSONP for IE7-9 (don't support CORS)
|
||||
|
||||
2.2.3 (2012-12-03)
|
||||
+ Detect HTTP method properly when accessing multi HTTP method endpoint (account/settings)
|
||||
+ Add friends/list, followers/list API methods
|
||||
+ Move users/recommendations to GET list
|
||||
|
||||
2.2.2 (2012-10-19)
|
||||
+ Update methods list for API 1.1
|
||||
+ Add profile banner methods
|
||||
- Drop separate media upload method
|
||||
- Remove OAuth token message. 1.1 is always signed.
|
||||
+ Update endpoints to 1.1 endpoints, add support for old endpoints
|
||||
|
||||
2.2.1 (2012-09-17)
|
||||
+ Update to Twitter API v1.1
|
||||
|
||||
2.2.0 (2012-09-17)
|
||||
+ Port Codebird from PHP to JavaScript
|
||||
@@ -0,0 +1,11 @@
|
||||
### Which branch?
|
||||
- Critical bugs are fixed in the master branch.
|
||||
- Normal bugs are fixed in the develop branch.
|
||||
- New features are added to the develop branch, too.
|
||||
|
||||
### Code style
|
||||
- Please use 4 soft spaces per indent level.
|
||||
- Take a look at the coding style used in codebird.js and apply the same convention to your contributed code.
|
||||
|
||||
### License
|
||||
- Code contributed by you will get the same license as Codebird itself, that is, GPU General Public License V3.
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@@ -0,0 +1,563 @@
|
||||
codebird-js
|
||||
===========
|
||||
*A Twitter library in JavaScript.*
|
||||
|
||||
Copyright (C) 2010-2014 Jublo IT Solutions <support@jublo.net>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
### Versions
|
||||
|
||||
- JavaScript: https://github.com/jublonet/codebird-js
|
||||
- PHP: https://github.com/jublonet/codebird-php
|
||||
|
||||
|
||||
0. Including Codebird
|
||||
---------------------
|
||||
|
||||
To include Codebird in your code, add its scripts to your markup:
|
||||
|
||||
```html
|
||||
<script type="text/javascript" src="codebird.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
var cb = new Codebird;
|
||||
cb.setConsumerKey("YOURKEY", "YOURSECRET");
|
||||
</script>
|
||||
```
|
||||
|
||||
You may also use a JavaScript module loader of your choice
|
||||
(such as [RequireJS](http://requirejs.org/) or the one bundled in Node.js)
|
||||
to load Codebird unobtrusively. In Node.js, loading Codebird looks like this:
|
||||
|
||||
```javascript
|
||||
var Codebird = require("codebird");
|
||||
// or with leading "./", if the codebird.js file is in your main folder:
|
||||
// var Codebird = require("./codebird");
|
||||
|
||||
var cb = new Codebird;
|
||||
cb.setConsumerKey("YOURKEY", "YOURSECRET");
|
||||
```
|
||||
|
||||
|
||||
1. Authentication
|
||||
-----------------
|
||||
|
||||
To authenticate your API requests on behalf of a certain Twitter user
|
||||
(following OAuth 1.0a), take a look at these steps:
|
||||
|
||||
```html
|
||||
<script type="text/javascript" src="codebird.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
var cb = new Codebird;
|
||||
cb.setConsumerKey("YOURKEY", "YOURSECRET");
|
||||
</script>
|
||||
```
|
||||
|
||||
You may either set the OAuth token and secret, if you already have them:
|
||||
```javascript
|
||||
cb.setToken("YOURTOKEN", "YOURTOKENSECRET");
|
||||
```
|
||||
|
||||
Or you authenticate, like this:
|
||||
|
||||
```javascript
|
||||
// gets a request token
|
||||
cb.__call(
|
||||
"oauth_requestToken",
|
||||
{oauth_callback: "oob"},
|
||||
function (reply) {
|
||||
// stores it
|
||||
cb.setToken(reply.oauth_token, reply.oauth_token_secret);
|
||||
|
||||
// gets the authorize screen URL
|
||||
cb.__call(
|
||||
"oauth_authorize",
|
||||
{},
|
||||
function (auth_url) {
|
||||
window.codebird_auth = window.open(auth_url);
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
Now you need to add a PIN box to your website.
|
||||
After the user enters the PIN, complete the authentication:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"oauth_accessToken",
|
||||
{oauth_verifier: document.getElementById("PINFIELD").value},
|
||||
function (reply) {
|
||||
// store the authenticated token, which may be different from the request token (!)
|
||||
cb.setToken(reply.oauth_token, reply.oauth_token_secret);
|
||||
|
||||
// if you need to persist the login after page reload,
|
||||
// consider storing the token in a cookie or HTML5 local storage
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
### 1.1. Application-only auth
|
||||
|
||||
Some API methods also support authenticating on a per-application level.
|
||||
This is useful for getting data that are not directly related to a specific
|
||||
Twitter user, but generic to the Twitter ecosystem (such as ```search/tweets```).
|
||||
|
||||
To obtain an app-only bearer token, call the appropriate API:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"oauth2_token",
|
||||
{},
|
||||
function (reply) {
|
||||
var bearer_token = reply.access_token;
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
I strongly recommend that you store the obtained bearer token in your database.
|
||||
There is no need to re-obtain the token with each page load, as it becomes invalid
|
||||
only when you call the ```oauth2/invalidate_token``` method.
|
||||
|
||||
If you already have your token, tell Codebird to use it:
|
||||
```javascript
|
||||
cb.setBearerToken("YOURBEARERTOKEN");
|
||||
```
|
||||
|
||||
For sending an API request with app-only auth, see the ‘Usage examples’ section.
|
||||
|
||||
### 1.2. Authenticating using a callback URL, without PIN
|
||||
|
||||
|
||||
1. Before sending your user off to Twitter, you have to store the request token and its secret, for example in a cookie.
|
||||
2. In the callback URL, extract those values and assign them to the Codebird object.
|
||||
3. Extract the ```oauth_verifier``` field from the request URI.
|
||||
|
||||
In Javascript, try extracting the URL parameter like this:
|
||||
|
||||
```javascript
|
||||
var cb = new Codebird;
|
||||
var current_url = location.toString();
|
||||
var query = current_url.match(/\?(.+)$/).split("&");
|
||||
var parameters = {};
|
||||
var parameter;
|
||||
|
||||
cb.setConsumerKey("STUFF", "HERE");
|
||||
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
parameter = query[i].split("=");
|
||||
if (parameter.length === 1) {
|
||||
parameter[1] = "";
|
||||
}
|
||||
parameters[decodeURIComponent(parameter[0])] = decodeURIComponent(parameter[1]);
|
||||
}
|
||||
|
||||
// check if oauth_verifier is set
|
||||
if (typeof parameters.oauth_verifier !== "undefined") {
|
||||
// assign stored request token parameters to codebird here
|
||||
// ...
|
||||
cb.setToken(stored_somewhere.oauth_token, stored_somewhere.oauth_token_secret);
|
||||
|
||||
cb.__call(
|
||||
"oauth_accessToken",
|
||||
{
|
||||
oauth_verifier: parameters.oauth_verifier
|
||||
},
|
||||
function (reply) {
|
||||
cb.setToken(reply.oauth_token, reply.oauth_token_secret);
|
||||
|
||||
// if you need to persist the login after page reload,
|
||||
// consider storing the token in a cookie or HTML5 local storage
|
||||
}
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
2. Usage examples
|
||||
-----------------
|
||||
|
||||
### Heads up
|
||||
|
||||
*Because the Consumer Key and Token Secret are available in the code
|
||||
it is important that you configure your app as read-only at Twitter,
|
||||
unless you are sure to know what you are doing.*
|
||||
|
||||
When you have an access token, calling the API is simple:
|
||||
|
||||
```javascript
|
||||
cb.setToken("YOURTOKEN", "YOURTOKENSECRET"); // see above
|
||||
|
||||
cb.__call(
|
||||
"statuses_homeTimeline",
|
||||
{},
|
||||
function (reply) {
|
||||
console.log(reply);
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
Tweeting is as easy as this:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"statuses_update",
|
||||
{"status": "Whohoo, I just tweeted!"},
|
||||
function (reply) {
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
For more complex parameters (see the [Twitter API documentation](https://dev.twitter.com/)),
|
||||
giving all parameters in an array is supported, too:
|
||||
|
||||
```javascript
|
||||
var params = {
|
||||
screen_name: "myx"
|
||||
};
|
||||
cb.__call(
|
||||
"users_show",
|
||||
params,
|
||||
function (reply) {
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
When **uploading files to Twitter**, the array syntax is obligatory,
|
||||
and the media have to be base64-encoded:
|
||||
|
||||
```javascript
|
||||
var params = {
|
||||
"status": "The bird is flying high. #larry",
|
||||
"media[]": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAIAAAD8GO2jAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAB+0lEQVR42mP8//8/Ay0BEwONwagFoxZQDljI0PP8x7/Z93/e+PxXmpMpXp5dh4+ZgYHh0bd/clxYnMuINaMtfvRLgp3RVZwVU+rkuz+eRz+//wXVxcrEkKnEceXTX0dRlhoNTmKDaOvzXwHHv6x9+gtN/M9/hpjTX+GmMzAw/P7HMOnOj+ff//35x/Ds+z9iLfjPwPDt7//QE1/Sz319/RNh3PkPf+58+Yup/t7Xf9p8zFKcTMRa4CLGCrFm1v2fSjs+pJ/7uuvl7w+//yO7HRkUq3GEyrCREMk+kqy2IiyH3/xhYGD48uf/rPs/Z93/yczIwM3CiFU9Hw5xnD4ouvTt4Tf0AP37n+HTb+w+UOBmIs2CICm2R9/+EZlqGRkYzIVYSLMgRIYtUYGdSAsMBFgUuJhIy2iMDAwt2pysjAwLHv78RcgnOcrs5BQVHEyMG579Imi6Nh9zrBxZFgixMW624pXnwldYcTAzLjDhZmUit7AzE2K54c7fp8eF1QhWRobFptwmgiwkF3b//jMwMjJ8+P3/zPs/yx/9Wvr412+MgBJlZ1xsyuOOrbAibMHH3/87b32fce/nR2ypnpuFMVGevU6TQ5SdqKKeEVez5cuf/7te/j727s+9L/++/v3PzcyowM1kIcTiLs7Kz8pIfNnOONouGrVg1AIGAJ6gvN4J6V9GAAAAAElFTkSuQmCC"
|
||||
);
|
||||
cb.__call(
|
||||
"statuses_updateWithMedia",
|
||||
params,
|
||||
function (reply) {
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
### Requests with app-only auth
|
||||
|
||||
To send API requests without an access token for a user (app-only auth),
|
||||
add another parameter to your method call, like this:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"search_tweets",
|
||||
"q=Twitter",
|
||||
function (reply) {
|
||||
// ...
|
||||
},
|
||||
true // this parameter required
|
||||
);
|
||||
```
|
||||
|
||||
Bear in mind that not all API methods support application-only auth.
|
||||
|
||||
3. Mapping API methods to Codebird function calls
|
||||
-------------------------------------------------
|
||||
|
||||
As you can see from the last example, there is a general way how Twitter’s API methods
|
||||
map to Codebird function calls. The general rules are:
|
||||
|
||||
1. For each slash in a Twitter API method, use an underscore in the Codebird function.
|
||||
|
||||
Example: ```statuses/update``` maps to ```cb.__call("statuses_update", ...)```.
|
||||
|
||||
2. For each underscore in a Twitter API method, use camelCase in the Codebird function.
|
||||
|
||||
Example: ```statuses/home_timeline``` maps to ```cb.__call("statuses_homeTimeline", ...)```.
|
||||
|
||||
3. For each parameter template in method, use UPPERCASE in the Codebird function.
|
||||
Also don’t forget to include the parameter in your parameter list.
|
||||
|
||||
Examples:
|
||||
- ```statuses/show/:id``` maps to ```cb.__call("statuses_show_ID", 'id=12345', ...)```.
|
||||
- ```users/profile_image/:screen_name``` maps to
|
||||
```cb.__call("users_profileImage_SCREEN_NAME", "screen_name=jublonet", ...)```.
|
||||
|
||||
4. HTTP methods (GET, POST, DELETE etc.)
|
||||
----------------------------------------
|
||||
|
||||
Never care about which HTTP method (verb) to use when calling a Twitter API.
|
||||
Codebird is intelligent enough to find out on its own.
|
||||
|
||||
5. Response codes
|
||||
-----------------
|
||||
|
||||
The HTTP response code that the API gave is included in any return values.
|
||||
You can find it within the return object’s ```httpstatus``` property.
|
||||
|
||||
### 5.1 Dealing with rate-limits
|
||||
|
||||
Basically, Codebird leaves it up to you to handle Twitter’s rate limit.
|
||||
The library returns the response HTTP status code, so you can detect rate limits.
|
||||
|
||||
I suggest you to check if the ```reply.httpstatus``` property is ```400```
|
||||
and check with the Twitter API to find out if you are currently being
|
||||
rate-limited.
|
||||
See the [Rate Limiting FAQ](https://dev.twitter.com/docs/rate-limiting-faq)
|
||||
for more information.
|
||||
|
||||
If you allow your callback function to accept a second parameter,
|
||||
you will receive rate-limiting details in this parameter.
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"search_tweets",
|
||||
"q=Twitter",
|
||||
function (reply, rate_limit_status) {
|
||||
console.log(rate_limit_status);
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
6. API calls and the same-origin policy
|
||||
---------------------------------------
|
||||
|
||||
Normally, browsers only allow requests being sent to addresses that are on
|
||||
the same base domain. This is a security feature called the “same-origin
|
||||
policy.” However, this policy is in your way when you try to access the
|
||||
(remote) Twitter API domain and its methods.
|
||||
|
||||
### 6.1 Cross-domain requests
|
||||
|
||||
With Codebird, don’t worry about this. We automatically send cross-domain
|
||||
requests using a secured proxy that sends back the required headers to the
|
||||
user’s browser.
|
||||
|
||||
This CORS proxy is using an encrypted SSL connection.
|
||||
*We do not record data sent to or from the Twitter API.
|
||||
Using Codebird’s CORS proxy is subject to the Acceptable use policy.*
|
||||
|
||||
If your JavaScript environment is not restricted under the same-origin policy
|
||||
(for example in node.js), direct connections to the Twitter API are established
|
||||
automatically, instead of contacting the CORS proxy.
|
||||
|
||||
You may also turn off the CORS compatibility manually like this:
|
||||
|
||||
```javascript
|
||||
cb.setUseProxy(false);
|
||||
```
|
||||
|
||||
### 6.2 Support for Internet Explorer 7 to 9
|
||||
|
||||
Cross-domain requests work well in any browser except for
|
||||
Internet Explorer 7-9. Codebird cannot send POST requests in these browsers.
|
||||
For IE7-9, Codebird works in limited operation mode:
|
||||
|
||||
- Calls to GET methods work fine,
|
||||
- calling POST methods is impossible,
|
||||
- Application-only auth does not work.
|
||||
|
||||
### 6.3 Using your own proxy server
|
||||
|
||||
The source code of the CORS proxy is publicly available. If you want to,
|
||||
set up your own instance on your server. Afterwards, tell Codebird the
|
||||
address:
|
||||
|
||||
```javascript
|
||||
cb.setProxy("https://example.com/codebird-cors-proxy/");
|
||||
```
|
||||
|
||||
Heads up! Follow the notes in the [codebird-cors-proxy README](https://github.com/jublonet/codebird-cors-proxy/#readme) for details.
|
||||
|
||||
7. Using multiple Codebird instances
|
||||
------------------------------------
|
||||
|
||||
By default, each Codebird instance works on its own.
|
||||
|
||||
If you need to run requests to the Twitter API for multiple users at once,
|
||||
Codebird supports this automatically. Just create a new object:
|
||||
|
||||
```javascript
|
||||
var cb1 = new Codebird;
|
||||
var cb2 = new Codebird;
|
||||
```
|
||||
|
||||
Please note that your OAuth consumer key and secret is shared within
|
||||
multiple Codebird instances, while the OAuth request and access tokens with their
|
||||
secrets are *not* shared.
|
||||
|
||||
How Do I…?
|
||||
==========
|
||||
|
||||
…get user ID, screen name and more details about the current user?
|
||||
------------------------------------------------------------------
|
||||
|
||||
When the user returns from the authentication screen, you need to trade
|
||||
the obtained request token for an access token, using the OAuth verifier.
|
||||
As discussed in the section ‘Usage example,’ you use a call to
|
||||
```oauth/access_token``` to do that.
|
||||
|
||||
The API reply to this method call tells you details about the user that just logged in.
|
||||
These details contain the **user ID** and the **screen name.**
|
||||
|
||||
Take a look at the returned data as follows:
|
||||
|
||||
```javascript
|
||||
{
|
||||
oauth_token: "14648265-rPn8EJwfB**********************",
|
||||
oauth_token_secret: "agvf3L3**************************",
|
||||
user_id: 14648265,
|
||||
screen_name: "myx",
|
||||
httpstatus: 200
|
||||
}
|
||||
```
|
||||
|
||||
If you need to get more details, such as the user’s latest tweet,
|
||||
you should fetch the complete User Entity. The simplest way to get the
|
||||
user entity of the currently authenticated user is to use the
|
||||
```account/verify_credentials``` API method. In Codebird, it works like this:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"account_verifyCredentials",
|
||||
{},
|
||||
function (reply) {
|
||||
console.log(reply);
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
I suggest to cache the User Entity after obtaining it, as the
|
||||
```account/verify_credentials``` method is rate-limited by 15 calls per 15 minutes.
|
||||
|
||||
…walk through cursored results?
|
||||
-------------------------------
|
||||
|
||||
The Twitter REST API utilizes a technique called ‘cursoring’ to paginate
|
||||
large result sets. Cursoring separates results into pages of no more than
|
||||
5000 results at a time, and provides a means to move backwards and
|
||||
forwards through these pages.
|
||||
|
||||
Here is how you can walk through cursored results with Codebird.
|
||||
|
||||
1. Get the first result set of a cursored method:
|
||||
```javascript
|
||||
cb.__call(
|
||||
"followers_list",
|
||||
{},
|
||||
function (result1) {
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
2. To navigate forth, take the ```next_cursor_str```:
|
||||
```javascript
|
||||
var nextCursor = result1.next_cursor_str;
|
||||
```
|
||||
|
||||
3. If ```nextCursor``` is not 0, use this cursor to request the next result page:
|
||||
```javascript
|
||||
if (nextCursor > 0) {
|
||||
cb.__call(
|
||||
"followers_list",
|
||||
{cursor: nextCursor},
|
||||
function (result2) {
|
||||
// ...
|
||||
}
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
To navigate back instead of forth, use the field ```resultX.previous_cursor_str```
|
||||
instead of ```next_cursor_str```.
|
||||
|
||||
It might make sense to use the cursors in a loop. Watch out, though,
|
||||
not to send more than the allowed number of requests to ```followers/list```
|
||||
per rate-limit timeframe, or else you will hit your rate-limit.
|
||||
|
||||
…use xAuth with Codebird?
|
||||
-------------------------
|
||||
|
||||
Codebird supports xAuth just like every other authentication used at Twitter.
|
||||
Remember that your application needs to be whitelisted to be able to use xAuth.
|
||||
|
||||
Here’s an example:
|
||||
```javascript
|
||||
cb.__call(
|
||||
"oauth_accessToken",
|
||||
{
|
||||
"x_auth_username": "username",
|
||||
"x_auth_password": "4h3_p4$$w0rd",
|
||||
"x_auth_mode" : "client_auth"
|
||||
},
|
||||
function (reply) {
|
||||
console.log(reply);
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
If everything went fine, you will get an object like this:
|
||||
|
||||
```javascript
|
||||
{
|
||||
"oauth_token": "14648265-ABLfBFlE*********************************",
|
||||
"oauth_token_secret": "9yTBY3pEfj*********************************",
|
||||
"user_id": "14648265",
|
||||
"screen_name": "myx",
|
||||
"x_auth_expires": "0",
|
||||
"httpstatus": 200
|
||||
}
|
||||
```
|
||||
|
||||
Are you getting a strange error message, an empty error, or status "0"?
|
||||
If the user is enrolled in login verification, the server will return a
|
||||
HTTP 401 error with a custom body (that may be filtered by your browser).
|
||||
|
||||
You may check the browser web console for an error message.
|
||||
|
||||
When this error occurs, advise the user to
|
||||
[generate a temporary password](https://twitter.com/settings/applications)
|
||||
on twitter.com and use that to complete signing in to the application.
|
||||
|
||||
…access and use undocumented Twitter API methods?
|
||||
-------------------------------------------------
|
||||
|
||||
Besides the well-documented official methods, the Twitter API also contains
|
||||
undocumented additional methods. They are used by official Twitter clients,
|
||||
such as Twitter for iPhone and Twitter for Mac.
|
||||
|
||||
Access to these methods is restricted: Only white-listed applications
|
||||
(consumer keys) may access undocumented methods. Codebird supports accessing
|
||||
internal methods, but that will only work if you provide a white-listed API key.
|
||||
By reason, the API keys and secrets for official Twitter clients are not
|
||||
provided within this package, since they should have been kept a secret.
|
||||
|
||||
If you provide Codebird with the Twitter for iPhone consumer key and secret,
|
||||
the following example will get the latest events that happened with you:
|
||||
|
||||
```javascript
|
||||
cb.__call(
|
||||
"activity_aboutMe",
|
||||
{},
|
||||
function (reply) {
|
||||
console.log(reply);
|
||||
// ...
|
||||
}
|
||||
);
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "codebird",
|
||||
"version": "2.5.0-alpha.1.1",
|
||||
"description": "A Twitter library in JavaScript.",
|
||||
"main": "codebird.js",
|
||||
"directories": {
|
||||
"example": "examples"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/jublonet/codebird-js.git"
|
||||
},
|
||||
"keywords": [
|
||||
"Twitter",
|
||||
"API",
|
||||
"networking",
|
||||
"CORS"
|
||||
],
|
||||
"author": "Jublo IT Solutions <support@jublo.net> (http://jublo.net/)",
|
||||
"license": "GPL-3.0+",
|
||||
"bugs": {
|
||||
"url": "https://github.com/jublonet/codebird-js/issues"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user