https://github.com/hyperoslo/mingle
Social media integration for Ruby on Rails
https://github.com/hyperoslo/mingle
Last synced: about 1 year ago
JSON representation
Social media integration for Ruby on Rails
- Host: GitHub
- URL: https://github.com/hyperoslo/mingle
- Owner: hyperoslo
- License: other
- Created: 2014-02-22T11:47:16.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-04-09T11:22:44.000Z (about 11 years ago)
- Last Synced: 2024-03-14T21:06:17.383Z (over 2 years ago)
- Language: Ruby
- Homepage: http://rubygems.org/gems/mingle
- Size: 860 KB
- Stars: 20
- Watchers: 15
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.md
Awesome Lists containing this project
README
# Mingle
[](https://rubygems.org/gems/mingle)
[](https://travis-ci.org/hyperoslo/mingle)
[](https://gemnasium.com/hyperoslo/mingle)
[](https://codeclimate.com/github/hyperoslo/mingle)
[](https://coveralls.io/r/hyperoslo/mingle)
Mingle makes it really easy to syndicate tweets from Twitter and photos from Instagram
in your Ruby on Rails application.
## Installation
Add this line to your application's Gemfile:
gem 'mingle'
And then execute:
$ bundle
Or install it yourself as:
$ gem install mingle
Install the migrations:
rake mingle:install:migrations
Run the migrations:
rake db:migrate
## Usage
```ruby
# Create some hashtags to syndicate content from
Mingle::Hashtag.create tag_name: "#hyper"
# Fetch tweets from Twitter
Mingle::Twitter.fetch
# Fetch photos from Instagram
Mingle::Instagram.fetch
```
Mingle also ships with rake tasks:
```bash
$ rake mingle:twitter:fetch
$ rake mingle:instagram:fetch
```
## Jobs
Mingle ships with Sidekiq jobs for your perusal.
## Configuration
Mingle is configured through `Mingle.configure`, like this:
```ruby
Mingle.configure do |config|
config.twitter_api_key = ENV['TWITTER_API_KEY']
# ...
end
```
You can also configure it temporarily:
```ruby
Mingle.temporarily twitter_api_key: 'ABC123' do
# ...
end
```
The following configurations can be made through `Mingle.configure`:
* `twitter_api_key` - A Twitter application's API key.
* `twitter_api_secret` - A Twitter application's API secret.
* `twitter_access_token` - A Twitter application's access token.
* `twitter_access_token_secret` - A Twitter application's access token secret.
* `instagram_client_id` - An Instagram application's client id.
* `twitter_reject_words` - An array of words which will prevent a tweet from being imported.
* `twitter_reject_users` - An array of Twitter user names whose tweets will not be imported.
* `instagram_reject_words` - An array of words which will prevent an Instagram photo from being imported.
* `instagram_reject_users` - An array of Instagram user names whose Instagram photos will not be imported.
* `since` - A date before which posts, tweets and photos will be ignored.
**Note:** We recommend you store your application configuration in your
environment, like in the example above. In fact, we recommend it so much that
Mingle will automatically look for environment variables with specific names,
unless you configure them through `Mingle.configure`.
Mingle checks for following environment variables by default:
* `TWITTER_API_KEY` - the equivalent of `twitter_api_key`
* `TWITTER_API_SECRET` - the equivalent of `twitter_api_secret`
* `TWITTER_ACCESS_TOKEN` - the equivalent of `twitter_access_token`
* `TWITTER_ACCESS_TOKEN_SECRET` - the equivalent of `twitter_access_token_secret`
* `INSTAGRAM_CLIENT_ID` - the equivalent of `instagram_client_id`
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Credits
Hyper made this. We're a digital communications agency with a passion for good code,
and if you're using this library we probably want to hire you.
## License
Mingle is available under the MIT license. See the LICENSE file for more info.