groupme 0.0.1.pre → 0.0.1

data/.pryrc

@@ -0,0 +1 @@
+require 'groupme'

data/.rspec

@@ -0,0 +1,4 @@
+--color
+#--fail-fast
+--order random
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree

data/README.md

@@ -1,4 +1,4 @@
-# Groupme
+# groupme [![Build Status](https://secure.travis-ci.org/dwradcliffe/groupme.png?branch=master)](https://travis-ci.org/dwradcliffe/groupme) [![Dependency Status](https://gemnasium.com/dwradcliffe/groupme.png)](https://gemnasium.com/dwradcliffe/groupme) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dwradcliffe/groupme)
 
 Simple wrapper for the GroupMe v3 API.
 
@@ -16,6 +16,11 @@ Or install it yourself as:
 
     $ gem install groupme
 
+## Documentation
+[http://rdoc.info/github/dwradcliffe/groupme][documentation]
+
+[documentation]: http://rdoc.info/github/dwradcliffe/groupme
+
 ## Usage
 
 TODO: Write usage instructions here

data/Rakefile

@@ -1 +1,18 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/groupme.gemspec

@@ -5,7 +5,7 @@ require 'groupme/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "groupme"
-  gem.version       = Groupme::VERSION
+  gem.version       = GroupMe::VERSION
   gem.authors       = ["David Radcliffe"]
   gem.email         = ["radcliffe.david@gmail.com"]
   gem.description   = %q{Simple wrapper for the GroupMe v3 API}
@@ -17,4 +17,18 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'json', '~> 1.7'
+
+  gem.add_dependency 'faraday', '~> 0.8'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
+  gem.add_dependency 'hashie', '~> 1.2'
+  gem.add_dependency 'multi_json', '~> 1.3'
+  gem.add_dependency 'simple_oauth', '~> 0.1.6'
 end

data/lib/groupme.rb

@@ -1,4 +1,6 @@
 require "groupme/version"
+require "groupme/client"
 
-module Groupme
+module GroupMe
+  USER_AGENT = "dwradcliffe/groupme/#{GroupMe::VERSION}"
 end

data/lib/groupme/bots.rb

@@ -0,0 +1,29 @@
+module GroupMe
+  module Bots
+
+    # List the authenticated user's bots.
+    #
+    # @return [Array<Hashie::Mash>] Array of hashes representing bots.
+    # @see http://dev.groupme.com/docs/v3#bots_index
+    # @example
+    #   client = GroupMe::Client.new
+    #   client.bots
+    def bots
+      get("/bots")
+    end
+    alias :list_bots :bots
+
+    # Get a single bot.
+    #
+    # @return [Hashie::Mash] Hash representing the bot.
+    # @see http://dev.groupme.com/docs/v3#bots_show
+    # @example
+    #   client = GroupMe::Client.new
+    #   client.bot(32)
+    def bot(id)
+      get("/bots/#{id}")
+    end
+
+
+  end
+end

data/lib/groupme/client.rb

@@ -0,0 +1,55 @@
+require 'groupme/groups'
+require 'groupme/members'
+require 'groupme/bots'
+require 'faraday_middleware'
+
+module GroupMe
+  class Client
+
+    def initialize(options={})
+      @token = options[:token].to_s
+      raise ArgumentError, ":token can't be blank" if @token.empty?
+    end
+
+    include GroupMe::Groups
+    include GroupMe::Members
+    include GroupMe::Bots
+
+    private
+
+      def get(path)
+        request(:get, path)
+      end
+
+      def post(path, data)
+        request(:post, path, data)
+      end
+
+      def request(method, path, data={})
+        res = connection.send(method, "v3/#{path}", data)
+        if res.status == 200
+          return res.body.response
+        else
+          return res
+        end
+      end
+
+      # Returns a Faraday::Connection object
+      #
+      # @return [Faraday::Connection]
+      def connection
+        @connection ||= Faraday.new 'https://api.groupme.com/' do |f|
+          f.request :json
+          f.headers[:user_agent] = GroupMe::USER_AGENT
+          f.headers["X-Access-Token"] = @token
+
+          # f.response :logger
+          f.response :mashify
+          f.response :json, :content_type => /\bjson$/
+
+          f.adapter Faraday.default_adapter
+        end
+      end
+
+  end
+end

data/lib/groupme/groups.rb

@@ -0,0 +1,54 @@
+module GroupMe
+  module Groups
+
+    # List the authenticated user's active groups.
+    #
+    # @return [Array<Hashie::Mash>] Array of hashes representing groups.
+    # @see http://dev.groupme.com/docs/v3#groups_index
+    # @example
+    #   client = GroupMe::Client.new
+    #   client.groups
+    def groups
+      get "/groups"
+    end
+    alias :list_groups :groups
+
+    # Load a specific group.
+    #
+    # @return [Hashie::Mash] Hash representing the group.
+    # @see http://dev.groupme.com/docs/v3#groups_show
+    # @param id [String, Integer] The ID of the group
+    # @example
+    #   client = GroupMe::Client.new
+    #   client.group(32)
+    def group(id)
+      get "/groups/#{id}"
+    end
+
+    # List the authenticated user's former groups.
+    #
+    # @return [Array<Hashie::Mash>] Array of hashes representing groups.
+    # @see http://dev.groupme.com/docs/v3#groups_index_former
+    # @example
+    #   client = GroupMe::Client.new
+    #   client.former_groups
+    def former_groups
+      get '/groups/former'
+    end
+    alias :list_former_groups :former_groups
+
+    # Create a new group.
+    #
+    # @return [Hashie::Mash] Hash representing the group
+    # @see
+    # @param name [String] Name for the new group
+    # @param options [Hash] Group information
+    # @option options [String] :description Description of the group
+    # @option options [String] :image Base64 JPEG or PNG data
+    def create_group(name, options={})
+      options.merge! :name => name
+      post '/groups', options
+    end
+
+  end
+end

data/lib/groupme/members.rb

@@ -0,0 +1,35 @@
+module GroupMe
+  module Members
+
+    # Add members to a group
+    #
+    # @return [Boolean] Success/Failure
+    # @see http://dev.groupme.com/docs/v3#members_add
+    # @param id [String, Integer] Id of the group
+    # @param members [Array<Hash>] Members to be added
+    # @option members [String] :nickname
+    # @option members [String] :user_id Existing user id
+    # @option members [String] :phone_number
+    # @option members [String] :email
+    # @option members [String] :guid
+    def add_members(id, members)
+      post("/groups/#{id}/members/add", members).status == 202
+    end
+
+    # Add member to a group
+    #
+    # @return [Boolean] Success/Failure
+    # @see http://dev.groupme.com/docs/v3#members_add
+    # @param id [String, Integer] Id of the group
+    # @param member [Hash] Member to be added
+    # @option member [String] :nickname
+    # @option member [String] :user_id Existing user id
+    # @option member [String] :phone_number
+    # @option member [String] :email
+    # @option member [String] :guid
+    def add_member(id, member)
+      post("/groups/#{id}/members/add", [member]).status == 202
+    end
+
+  end
+end

data/lib/groupme/version.rb

@@ -1,3 +1,3 @@
-module Groupme
-  VERSION = "0.0.1.pre"
+module GroupMe
+  VERSION = "0.0.1"
 end

data/spec/fixtures/bot.json

@@ -0,0 +1,6 @@
+{
+  "bot_id": "1234567890",
+  "group_id": "1234567890",
+  "name": "hal9000",
+  "callback_url": "http://example.com/bots/callback"
+}

data/spec/fixtures/bots.json

@@ -0,0 +1,8 @@
+[
+  {
+    "bot_id": "1234567890",
+    "group_id": "1234567890",
+    "name": "hal9000",
+    "callback_url": "http://example.com/bots/callback"
+  }
+]

data/spec/fixtures/former_groups.json

@@ -0,0 +1,30 @@
+[
+  {
+    "id": "1234567890",
+    "name": "Previous Family",
+    "type": "private",
+    "description": "Coolest Family Ever",
+    "image_url": "http://i.groupme.com/123456789.jpg",
+    "creator_user_id": "1234567890",
+    "created_at": 1302623328,
+    "updated_at": 1302623328,
+    "members": [
+      {
+        "user_id": "1234567890",
+        "nickname": "Jane",
+        "muted": false,
+        "image_url": "http://i.groupme.com/123456789.jpg"
+      }
+    ],
+    "messages": {
+      "count": 100,
+      "last_message_id": "1234567890",
+      "last_message_created_at": 1302623328,
+      "preview": {
+        "nickname": "Jane",
+        "text": "Hello world",
+        "image_url": "http://i.groupme.com/123456789.jpg"
+      }
+    }
+  }
+]

data/spec/fixtures/group.json

@@ -0,0 +1,28 @@
+{
+  "id": "1234567890",
+  "name": "Family",
+  "type": "private",
+  "description": "Coolest Family Ever",
+  "image_url": "http://i.groupme.com/123456789.jpg",
+  "creator_user_id": "1234567890",
+  "created_at": 1302623328,
+  "updated_at": 1302623328,
+  "members": [
+    {
+      "user_id": "1234567890",
+      "nickname": "Jane",
+      "muted": false,
+      "image_url": "http://i.groupme.com/123456789.jpg"
+    }
+  ],
+  "messages": {
+    "count": 100,
+    "last_message_id": "1234567890",
+    "last_message_created_at": 1302623328,
+    "preview": {
+      "nickname": "Jane",
+      "text": "Hello world",
+      "image_url": "http://i.groupme.com/123456789.jpg"
+    }
+  }
+}

data/spec/fixtures/groups.json

@@ -0,0 +1,30 @@
+[
+  {
+    "id": "1234567890",
+    "name": "Family",
+    "type": "private",
+    "description": "Coolest Family Ever",
+    "image_url": "http://i.groupme.com/123456789.jpg",
+    "creator_user_id": "1234567890",
+    "created_at": 1302623328,
+    "updated_at": 1302623328,
+    "members": [
+      {
+        "user_id": "1234567890",
+        "nickname": "Jane",
+        "muted": false,
+        "image_url": "http://i.groupme.com/123456789.jpg"
+      }
+    ],
+    "messages": {
+      "count": 100,
+      "last_message_id": "1234567890",
+      "last_message_created_at": 1302623328,
+      "preview": {
+        "nickname": "Jane",
+        "text": "Hello world",
+        "image_url": "http://i.groupme.com/123456789.jpg"
+      }
+    }
+  }
+]

data/spec/groupme/bots_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe GroupMe::Bots do
+
+  before do
+    @client = GroupMe::Client.new(:token => "TEST")
+  end
+
+  describe ".bots" do
+
+    it "returns user's bots" do
+      stub_get("/bots").to_return(json_response("bots.json"))
+      bots = @client.bots
+      expect(bots.first.name).to eq("hal9000")
+    end
+
+  end
+
+  describe ".bot" do
+
+    it "returns the matching bot" do
+      stub_get("/bots/1234567890").to_return(json_response("bot.json"))
+      bot = @client.bot(1234567890)
+      expect(bot.name).to eq("hal9000")
+    end
+
+  end
+
+end

data/spec/groupme/client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe GroupMe::Client do
+
+  it "requires an access token" do
+    expect{ GroupMe::Client.new }.to raise_error(ArgumentError)
+  end
+
+end

data/spec/groupme/groups_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe GroupMe::Groups do
+
+  before do
+    @client = GroupMe::Client.new(:token => "TEST")
+  end
+
+  describe ".groups" do
+
+    it "returns user's groups" do
+      stub_get("/groups").to_return(json_response("groups.json"))
+      groups = @client.groups
+      expect(groups.first.name).to eq("Family")
+    end
+
+  end
+
+  describe ".group" do
+
+    it "returns the matching group" do
+      stub_get("/groups/1234567890").to_return(json_response("group.json"))
+      group = @client.group(1234567890)
+      expect(group.name).to eq("Family")
+    end
+
+  end
+
+  describe ".former_groups" do
+
+    it "returns user's former groups" do
+      stub_get("/groups/former").to_return(json_response("former_groups.json"))
+      groups = @client.former_groups
+      expect(groups.first.name).to eq("Previous Family")
+    end
+
+  end
+
+  describe ".create_group" do
+
+    it "creates a group" do
+      stub_post("/groups", {:name => "Family"}).to_return(json_response("group.json"))
+      group = @client.create_group("Family")
+      expect(group.name).to eq("Family")
+    end
+
+  end
+
+end

data/spec/groupme/members_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe GroupMe::Members do
+
+  before do
+    @client = GroupMe::Client.new(:token => "TEST")
+  end
+
+  describe ".add_member" do
+
+    it "adds a single member to a group" do
+      member = {
+        :nickname => "Mom",
+        :user_id => "1234567890",
+        :guid => "SOME_GUID"
+      }
+      stub_post("/groups/1/members/add", [member]).to_return(:status => 202)
+      response = @client.add_member(1, member)
+      expect(response).to eq(true)
+    end
+
+  end
+
+  describe ".add_members" do
+
+    it "adds a list of members to a group" do
+      members = [{
+        :nickname => "Mom",
+        :user_id => "1234567890",
+        :guid => "SOME_GUID"
+      },{
+        :nickname => "Dad",
+        :phone_number => "+1 2123001234",
+        :guid => "SOME_GUID"
+      },{
+        :nickname => "Jane",
+        :email => "jane@example.com",
+        :guid => "SOME_GUID"
+      }]
+      stub_post("/groups/1/members/add", members).to_return(:status => 202)
+      response = @client.add_members(1, members)
+      expect(response).to eq(true)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'groupme'
+require 'multi_json'
+require 'webmock/rspec'
+
+def stub_get(url)
+  stub_request(:get, "https://api.groupme.com/v3#{url}").
+    with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>GroupMe::USER_AGENT})
+end
+
+def stub_post(url, data)
+  stub_request(:post, "https://api.groupme.com/v3#{url}").
+    with(:headers => {'Accept'=>'*/*', 'User-Agent'=>GroupMe::USER_AGENT, 'Content-Type'=>'application/json'}).
+    with(:body => MultiJson.dump(data))
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  MultiJson.load(File.read(fixture_path + '/' + file))
+end
+
+def json_response(file)
+  {
+    :body => {
+      :response => fixture(file),
+      :meta => {
+        :code => 200,
+        :errors => []
+      }
+    },
+    :headers => {
+      :content_type => 'application/json; charset=utf-8'
+    }
+  }
+end

metadata

@@ -1,16 +1,208 @@
 --- !ruby/object:Gem::Specification
 name: groupme
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - David Radcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
-dependencies: []
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
 description: Simple wrapper for the GroupMe v3 API
 email:
 - radcliffe.david@gmail.com
@@ -19,13 +211,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .pryrc
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - groupme.gemspec
 - lib/groupme.rb
+- lib/groupme/bots.rb
+- lib/groupme/client.rb
+- lib/groupme/groups.rb
+- lib/groupme/members.rb
 - lib/groupme/version.rb
+- spec/fixtures/bot.json
+- spec/fixtures/bots.json
+- spec/fixtures/former_groups.json
+- spec/fixtures/group.json
+- spec/fixtures/groups.json
+- spec/groupme/bots_spec.rb
+- spec/groupme/client_spec.rb
+- spec/groupme/groups_spec.rb
+- spec/groupme/members_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/dwradcliffe/groupme
 licenses:
 - MIT
@@ -39,16 +248,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4271238474333281864
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 4271238474333281864
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple wrapper for the GroupMe v3 API
-test_files: []
+test_files:
+- spec/fixtures/bot.json
+- spec/fixtures/bots.json
+- spec/fixtures/former_groups.json
+- spec/fixtures/group.json
+- spec/fixtures/groups.json
+- spec/groupme/bots_spec.rb
+- spec/groupme/client_spec.rb
+- spec/groupme/groups_spec.rb
+- spec/groupme/members_spec.rb
+- spec/spec_helper.rb
+has_rdoc: