groupme-api 0.4.0

data/spec/fixtures/groups/new.json

@@ -0,0 +1,43 @@
+{
+  "id": "44835902",
+  "group_id": "44835902",
+  "name": "Family Group",
+  "phone_number": "+1 6193780416",
+  "type": "private",
+  "description": null,
+  "image_url": null,
+  "creator_user_id": "3193012",
+  "created_at": 1538721837,
+  "updated_at": 1538721837,
+  "office_mode": false,
+  "share_url": null,
+  "share_qr_code_url": null,
+  "members": [
+    {
+      "id": "384075821",
+      "user_id": "3193012",
+      "nickname": "Test Account",
+      "muted": false,
+      "image_url": null,
+      "autokicked": false,
+      "roles": [
+        "admin",
+        "owner"
+      ],
+      "name": "Test Account"
+    }
+  ],
+  "max_memberships": 500,
+  "max_members": 500,
+  "messages": {
+    "count": 0,
+    "last_message_id": null,
+    "last_message_created_at": null,
+    "preview": {
+      "nickname": null,
+      "text": null,
+      "image_url": null,
+      "attachments": []
+    }
+  }
+}

data/spec/fixtures/groups/show.json

@@ -0,0 +1,42 @@
+{
+  "id": "44835935",
+  "group_id": "44835935",
+  "name": "Gaming Group",
+  "phone_number": "+1 3363554142",
+  "type": "private",
+  "description": "",
+  "image_url": null,
+  "creator_user_id": "3193012",
+  "created_at": 1538722180,
+  "updated_at": 1538722180,
+  "office_mode": false,
+  "share_url": null,
+  "share_qr_code_url": null,
+  "members": [
+    {
+      "user_id": "3193012",
+      "nickname": "Test Account",
+      "image_url": null,
+      "id": "384076097",
+      "muted": false,
+      "autokicked": false,
+      "roles": [
+        "admin",
+        "owner"
+      ],
+      "name": "Test Account"
+    }
+  ],
+  "messages": {
+    "count": 0,
+    "last_message_id": "",
+    "last_message_created_at": 0,
+    "preview": {
+      "nickname": null,
+      "text": null,
+      "image_url": null,
+      "attachments": []
+    }
+  },
+  "max_members": 500
+}

data/spec/groupme/configuration_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.describe GroupMe::Configuration do
+  after(:each) { GroupMe.reset! }
+
+  context 'when access token is not set' do
+    it 'should not raise an error' do
+      expect { GroupMe.configuration.access_token }.not_to raise_error
+    end
+
+    it 'should return nil' do
+      expect(GroupMe.configuration.access_token).to eq(nil)
+    end
+  end
+
+  context 'when access token is set' do
+    let(:access_token) { SecureRandom.base64(30) }
+
+    before do
+      GroupMe.configure { |config| config.access_token = access_token }
+    end
+
+    it 'should return it' do
+      expect(GroupMe.configuration.access_token).to eq(access_token)
+    end
+  end
+end

data/spec/groupme/group_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+RSpec.describe GroupMe::Group do
+  describe '#all' do
+  end
+end

data/spec/groupme/request_spec.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+RSpec.describe GroupMe::Request do
+  let(:access_token) { SecureRandom.base64(30) }
+
+  before do
+    GroupMe.configure { |config| config.access_token = access_token }
+  end
+
+  describe '.new' do
+    let(:request) { GroupMe::Request.new(method, path, opts) }
+
+    context 'when no parameters are set' do
+      let(:request) { GroupMe::Request.new }
+
+      it 'should use :get as the method' do
+        expect(request.method).to eq(:get)
+      end
+
+      it 'should use empty path as the path' do
+        expect(request.path).to eq('')
+      end
+
+      it 'should have an empty Hash as opts' do
+        expect(request.opts).to eq({})
+      end
+    end
+
+    context 'when method is not :get, :post, or :delete' do
+      it 'should raise an error' do
+        expect { GroupMe::Request.new(:patch) }.to raise_error(GroupMe::UnacceptableRequestMethodError)
+      end
+    end
+  end
+
+  describe '#send' do
+    let(:request) { GroupMe::Request.new(:get, 'groups') }
+
+    it 'should not return an error' do
+      expect { request.send }.not_to raise_error
+    end
+
+    it 'should be get back a GroupMe::Response object' do
+      response = request.send
+
+      expect(response).to be_an_instance_of(GroupMe::Response)
+    end
+  end
+
+  describe '#method' do
+    let(:request) { GroupMe::Request.new(:delete, 'groups', per_page: 100) }
+
+    it 'should be able to retrieve the method' do
+      expect(request.method).to eq(:delete)
+    end
+  end
+
+  describe '#path' do
+    let(:request) { GroupMe::Request.new(:delete, 'groups', per_page: 100) }
+
+    it 'should be able to retrieve the path' do
+      expect(request.path).to eq('groups')
+    end
+  end
+
+  describe '#opts' do
+    let(:request) { GroupMe::Request.new(:delete, 'groups', per_page: 100) }
+
+    it 'should be able to retrieve the opts' do
+      expect(request.opts).to eq({ per_page: 100 })
+    end
+  end
+
+  describe '#full_uri' do
+    let(:request)  { GroupMe::Request.new(:get, 'groups') }
+    let(:base_uri) { GroupMe::Request::API_BASE_URI }
+
+    it 'should be able to build & return a full uri' do
+      expect(request.full_uri).to eq("#{base_uri}/groups")
+    end
+  end
+
+  describe '#full_opts' do
+    let(:request) { GroupMe::Request.new(:get, 'groups', opts) }
+
+    context 'when opts are not initially set' do
+      let(:opts) { {} }
+
+      it 'should return just the token' do
+        expect(request.full_opts).to eq({ token: access_token })
+      end
+    end
+
+    context 'when opts are initially set' do
+      let(:opts) { { per_page: 100 } }
+
+      it 'should return opts & token' do
+        expect(request.full_opts).to eq({ token: access_token, per_page: 100 })
+      end
+    end
+
+    context 'when one of the opts is a new token' do
+      let(:new_access_token) { SecureRandom.base64(30) }
+      let(:opts) { { token: new_access_token, per_page: 100 } }
+
+      it 'should return opts & only the new token' do
+        expect(request.full_opts).to eq({ token: new_access_token, per_page: 100 })
+      end
+    end
+  end
+
+  describe '#token' do
+    context 'no token is specified in opts' do
+      let(:request)  { GroupMe::Request.new(:get, 'groups') }
+
+      it 'should use the configured token' do
+        expect(request.token).to eq(access_token)
+      end
+    end
+
+    context 'a different token is specified in opts' do
+      let(:new_access_token) { SecureRandom.base64(30) }
+      let(:request)  { GroupMe::Request.new(:get, 'groups', token: new_access_token) }
+
+      it 'should use the new token' do
+        expect(request.token).to eq(new_access_token)
+      end
+    end
+  end
+end

data/spec/groupme/response_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+RSpec.describe GroupMe::Response do
+  let(:request)  { GroupMe::Request.new(:get, 'groups') }
+  let(:response) { request.send }
+
+  describe '#new' do
+    it 'should initialize a GroupMe::Response object' do
+      expect(response).to be_an_instance_of(GroupMe::Response)
+    end
+  end
+
+  describe '.raw' do
+    it 'should return an HTTP::Response object' do
+      expect(response.raw).to be_an_instance_of(HTTP::Response)
+    end
+  end
+
+  describe '.code' do
+    let(:actual_code) { response.raw.code }
+
+    it 'should the response status code' do
+      expect(response.code).to eq(actual_code)
+    end
+  end
+
+  describe '.body' do
+    let(:response_body) { response.body }
+
+    context 'when response will be an array' do
+      let(:request)  { GroupMe::Request.new(:get, 'groups') }
+
+      it 'should parse the JSON response into an Array' do
+        expect(response_body).to be_an_instance_of(Array)
+      end
+
+      it 'should symbolize names' do
+        keys = response_body.first.keys
+
+        expect(keys.all? { |k| k.is_a? Symbol }).to eq(true)
+      end
+    end
+
+    context 'when response will be an hash' do
+      let(:request)  { GroupMe::Request.new(:get, 'groups/1234567890') }
+
+      it 'should parse the JSON response into an Hash' do
+        expect(response_body).to be_an_instance_of(Hash)
+      end
+
+      it 'should symbolize names' do
+        expect(response_body.keys.all? { |k| k.is_a? Symbol }).to eq(true)
+      end
+
+      it 'should not have the key "response"' do
+        expect(response_body.has_key?(:response)).to eq(false)
+      end
+
+      it 'should not have the key "meta"' do
+        expect(response_body.has_key?(:meta)).to eq(false)
+      end
+    end
+  end
+end

data/spec/groupme_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GroupMe do
+  it 'has a version number' do
+    expect(GroupMe::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'coveralls'
+require 'webmock'
+
+SimpleCov.start
+Coveralls.wear!
+WebMock.enable!
+
+require 'bundler/setup'
+require 'groupme'
+require 'support/fake_groupme'
+require 'securerandom'
+
+RSpec.configure do |config|
+  include WebMock::API
+
+  config.filter_run_when_matching :focus
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    stub_request(:any, /api.groupme.com/).to_rack(FakeGroupMe)
+  end
+end

data/spec/support/fake_groupme.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'sinatra/namespace'
+
+class FakeGroupMe < Sinatra::Base
+  register Sinatra::Namespace
+
+  namespace '/v3' do
+    get '/groups' do
+      json_response('groups/index', 200)
+    end
+
+    get '/groups/:group_id' do
+      json_response('groups/show', 200)
+    end
+  end
+
+  private
+
+  def json_response(fixture_path, status_code = 200)
+    "{\"response\":#{json_response_body(fixture_path)},\"meta\":{\"code\":#{status_code}}}"
+  end
+
+  def json_response_body(fixture_path)
+    File.open("#{File.dirname(__dir__)}/fixtures/#{fixture_path}.json").read
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: groupme-api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Kinnell Shah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: kinnell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- groupme-api.gemspec
+- lib/groupme.rb
+- lib/groupme/configuration.rb
+- lib/groupme/group.rb
+- lib/groupme/request.rb
+- lib/groupme/response.rb
+- lib/groupme/version.rb
+- spec/fixtures/groups/index.json
+- spec/fixtures/groups/new.json
+- spec/fixtures/groups/show.json
+- spec/groupme/configuration_spec.rb
+- spec/groupme/group_spec.rb
+- spec/groupme/request_spec.rb
+- spec/groupme/response_spec.rb
+- spec/groupme_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_groupme.rb
+homepage: https://github.com/kinnell/groupme-ruby-gem
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for GroupMe REST API (v3)
+test_files: []