New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

fellowshipone

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fellowshipone

Fellowship One (F1) API wrapper for Node.js

  • 0.3.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3
decreased by-50%
Maintainers
1
Weekly downloads
 
Created
Source

Build Status Code Coverage Code Climate Dependency Status Current Version

Stories in Ready Stories In Progress

JS Standard Code Style

node-fellowshipone

A Fellowship One API wrapper for Node.js

In very early stages.

Allows you to:

  • use a username/password to easily get OAuth tokens for dealing with Fellowship One (i.e. 2nd-party credentials-based authentication)
  • interface with the F1 API in a slightly-simplified way

See passport-fellowshipone for 3rd-party OAuth authentication.

Install

$ npm install fellowshipone

Usage

Getting a token

var f1 = new F1({
  apiURL: 'http://mychurch.staging.fellowshiponeapi.com/v1',
  username: 'joe',
  password: 'joespassword',
  oauth_credentials: {
    consumer_key: '123',
    consumer_secret: '456789'
  }
})
f1.get_token(function (err, oauth_credentials, userURL) {
  request.get(userURL, { oauth: oauth_credentials, json: true }, function (err, res, body) {
    console.log('hi there, %s %s', body.firstName, body.lastName)
  })
})

Getting a token - alternate method

var config = {
  apiURL: 'http://mychurch.staging.fellowshiponeapi.com/v1',
  username: 'joe',
  password: 'joespassword',
  oauth_credentials: {
    consumer_key: '123',
    consumer_secret: '456789'
  }
}
var f1 = new F1(config)
// this method is useful for integrating with other APIs
f1.authenticate(function (err) {
  console.log('got tokens: %s/%s', config.oauth_credentials.token,
    config.oauth_credentials.token_secret)
  console.log('user URL is %s', config.userURL)
})

Searching for Households

var f1 = new F1(config)
f1.authenticate(function (err) {
  var households = new F1.Households(f1)
  households.search({
    searchFor: 'Joe Smith'
  }, function (err, found) {
    var count = found.results['@count']
    console.log('Found %d households', count)
    if (count > 0) {
      console.log('Households: %j', found.results.household)
    }
  })
})

API Support

We're aiming to support all of the F1 API by v1.0.0. The (more-or-less) current support state is:

  • Accounts
  • People API Realm
    • Households
      • HouseholdMemberTypes
    • People
      • People Attributes
      • People Images
    • Addresses
      • AddressTypes
    • Attributes
      • AttributeGroups
    • Communications
      • CommunicationTypes
    • Denominations
    • Occupations
    • Schools
    • Statuses
      • SubStatuses
    • Requirements
    • Requirement Statuses
    • Background Check Statuses
    • People Requirements
    • Requirement Documents
  • Giving API Realm
    • not yet
  • Groups API Realm
    • not yet
  • Events API Realm
    • not yet

Tests

$ npm install --dev
$ make test

License

The MIT License

Copyright (c) 2014-2015 Dave Henderson

Keywords

FAQs

Package last updated on 23 Jul 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc