Merge pull request #12 from writeas/development

Merge changes into main branch

CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

CONTRIBUTING.md

@@ -2,7 +2,9 @@
 
 We're happy you're considering contributing to the WriteFreely Swift package!
 
-It won't take long to get up to speed on this. Here are our development resources:
+Before making a contribution, please be sure to familiarize yourself with our contributor's [code of conduct](CODE_OF_CONDUCT.md).
+
+Otherwise, it won't take long to get up to speed on this. Here are our development resources:
 
 * We accept and respond to bugs here on [GitHub](https://github.com/writeas/writefreely-swift/issues).
 * We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as).

README.md

@@ -6,24 +6,25 @@ A Swift package that wraps the [WriteFreely](https://writefreely.org) API, for u
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See _Deployment_ for notes on how to add the library to your app.
 
-## TODO
-
-- Add a test suite
-- Extend for use with [Write.as](https://write.as) (e.g., add `modifyToken` handling for unauthenticated post manipulation)
-- Improve `movePost(id: with modifyToken: to collectionAlias: completion:)` to return `Result<[Post], Error>`
-
 ### Prerequisites
 
 You'll need Xcode 11.5 / Swift 5.2 installed along with the command line tools to work on this package.
 
+Additionally, documentation is generated by [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc). After making any changes to the package's public API, you'll need to regenerate the docs; to do so, run the following commands in the terminal from the root directory of the package:
+
+```bash
+$ rm -rf docs/
+$ swift doc generate Sources --module-name WriteFreely --output docs
+```
+
 ### Installing
 
 1. Clone this repository.
-2. There is no step two.writefreely-swift
+2. There is no step two.
 
 ## Running the tests
 
-TK — see **TODO** section above
+TK
 
 ## Deployment
 

docs/Collection.md

@@ -0,0 +1,97 @@
+# Collection
+
+``` swift
+public struct Collection
+```
+
+## Inheritance
+
+`Decodable`
+
+## Initializers
+
+### `init(title:alias:)`
+
+Creates a basic `Collection` object.
+
+``` swift
+public init(title: String, alias: String?)
+```
+
+This initializer creates a bare-minimum `Collection` object for sending to the server; use the decoder-based
+initializer to populate its other properties from the server response.
+
+If no `alias` parameter is provided, one will be generated by the server.
+
+#### Parameters
+
+  - title: - title: The title to give the Collection.
+  - alias: - alias: The alias for the Collection.
+
+### `init(from:)`
+
+Creates a `Collection` object from the server response.
+
+``` swift
+public init(from decoder: Decoder) throws
+```
+
+Primarily used by the `WriteFreelyClient` to create a `Collection` object from the JSON returned by the server.
+
+#### Parameters
+
+  - decoder: - decoder: The decoder to use for translating the server response to a Swift object.
+
+#### Throws
+
+Error thrown by the `try` attempt when decoding any given property.
+
+## Properties
+
+### `alias`
+
+``` swift
+var alias: String?
+```
+
+### `title`
+
+``` swift
+var title: String
+```
+
+### `description`
+
+``` swift
+var description: String?
+```
+
+### `styleSheet`
+
+``` swift
+var styleSheet: String?
+```
+
+### `isPublic`
+
+``` swift
+var isPublic: Bool?
+```
+
+### `views`
+
+``` swift
+var views: Int?
+```
+
+### `email`
+
+``` swift
+var email: String?
+```
+
+### `url`
+
+``` swift
+var url: String?
+```

docs/Home.md

@@ -0,0 +1,6 @@
+# Types
+
+  - [Collection](/Collection)
+  - [Post](/Post)
+  - [User](/User)
+  - [WriteFreelyClient](/WriteFreelyClient)