adn-rb / adn

A Ruby library for App.net

NOTE: This project is not under active development.

ADN

A Ruby library for App.net by @kishyr.

This library follows the current App.net API Spec (as at 26 August 2012).

Contributors

ADN is brought to you by these very handsome gentlemen:

• Kishyr Ramdial (@kishyr)
• Dave Goodchild (@buddhamagnet)
• Peter Hellberg (@peterhellberg)

Installation

Simply add ADN to your Gemfile:

gem "adn"

Or you can install ADN directly from rubygems.org:

gem install adn

Usage

For API calls that accept parameters described in the App.net API Spec, simply pass them as a dictionary to the method.

  require 'adn'

  ADN.token = "your App.net OAuth-token here."

  # TODO: Actually describe the usage of the library
  #       (Should be refactored first)

Complete documentation will be available soon, but in the meantime you can browse all API methods in lib/adnruby.rb.

License

ADN is licensed under the MIT License and is Copyright (c) 2013 Kishyr Ramdial.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

adn's Issues

Extract constants into own file.

Too much coupling and non idiomatic Ruby (WIP)

1. We should take care not to introduce any more coupling between the classes.

The API classes have a clear separation of abstractions.

I want something like this:

require 'adn'

ADN.token = '…'

# Retrieving a user
kishyr = ADN::User.find(3089)
peter = ADN::User.find_by_username('peterhellberg')

# Retrieving a post
ADN::Post.find(313203)
peter.latest_post

2. Examples on where we need to improve the code:

• ADN.has_error? is just plain wrong in an OO design, the response object should take care of that.
• ADN.create_collection is another example, it doesn’t always return a collection and it has a strange second argument instead of being implemented as two separate methods.
• The methods (except the token, for now) in the ADN module should be moved into the API classes. We need to keep the top level clean from implementation details like HTTP request handling.

Refactor API URLs

Have done some more refactoring to extract the API URLs into constants.

Plans to implement user token

By looking at the code of the gem, I don't see any code that supports authentication via user token (especially helpful when you are implementing a web app that wants to give users access to their adn account)

Are there any plans to implement this feature? otherwise I will try to wrap my head around it and would just implement it.

Activate GitHub Service Hook for Travis CI

@kishyr You can follow the instructions on http://about.travis-ci.org/docs/user/getting-started/ to activate Travis CI for this repo (Very nice to get close to instant feedback on build failures)

I’ve already added an initial .travis.yml

Travis tweaks

Should we only run tests when a commit is made to master? Sometimes I am mid-branch and would like someone to have a look at a certain approach and sometimes that means all tests are not passing. Thoughts?

Add @ninjudd to the list of collaborators

What do you guys think about moving the project to an organization?

I have an organization here on GitHub: https://github.com/c7/

I’m thinking it would be pretty neat to have a ADN team which would have admin access to all the different project repos (adn, rack-adn, adn-rails, adn-cli).

Do you think it would be worth the effort to move the current repo?