koala 0.9.1 → 1.0.0.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. data/.gitignore +3 -0
  2. data/CHANGELOG +44 -7
  3. data/Gemfile +3 -0
  4. data/Manifest +10 -1
  5. data/Rakefile +13 -14
  6. data/koala.gemspec +36 -19
  7. data/lib/koala/graph_api.rb +188 -123
  8. data/lib/koala/http_services.rb +93 -18
  9. data/lib/koala/rest_api.rb +73 -6
  10. data/lib/koala/test_users.rb +85 -0
  11. data/lib/koala/uploadable_io.rb +115 -0
  12. data/lib/koala.rb +96 -82
  13. data/readme.md +21 -14
  14. data/spec/cases/api_base_spec.rb +101 -0
  15. data/spec/cases/graph_and_rest_api_spec.rb +31 -0
  16. data/spec/cases/graph_api_spec.rb +25 -0
  17. data/spec/cases/http_services/http_service_spec.rb +54 -0
  18. data/spec/cases/http_services/net_http_service_spec.rb +350 -0
  19. data/spec/cases/http_services/typhoeus_service_spec.rb +144 -0
  20. data/spec/cases/oauth_spec.rb +374 -0
  21. data/spec/cases/realtime_updates_spec.rb +184 -0
  22. data/spec/cases/rest_api_spec.rb +25 -0
  23. data/spec/cases/test_users_spec.rb +221 -0
  24. data/spec/cases/uploadable_io_spec.rb +151 -0
  25. data/spec/fixtures/beach.jpg +0 -0
  26. data/spec/{facebook_data.yml → fixtures/facebook_data.yml} +18 -14
  27. data/spec/{mock_facebook_responses.yml → fixtures/mock_facebook_responses.yml} +312 -241
  28. data/spec/spec_helper.rb +18 -0
  29. data/spec/support/graph_api_shared_examples.rb +424 -0
  30. data/spec/support/live_testing_data_helper.rb +40 -0
  31. data/spec/{mock_http_service.rb → support/mock_http_service.rb} +94 -80
  32. data/spec/support/rest_api_shared_examples.rb +161 -0
  33. data/spec/support/setup_mocks_or_live.rb +52 -0
  34. data/spec/support/uploadable_io_shared_examples.rb +76 -0
  35. metadata +134 -43
  36. data/init.rb +0 -2
  37. data/spec/koala/api_base_tests.rb +0 -96
  38. data/spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb +0 -10
  39. data/spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb +0 -11
  40. data/spec/koala/graph_api/graph_api_no_access_token_tests.rb +0 -114
  41. data/spec/koala/graph_api/graph_api_with_access_token_tests.rb +0 -150
  42. data/spec/koala/graph_api/graph_collection_tests.rb +0 -104
  43. data/spec/koala/live_testing_data_helper.rb +0 -23
  44. data/spec/koala/net_http_service_tests.rb +0 -186
  45. data/spec/koala/oauth/oauth_tests.rb +0 -433
  46. data/spec/koala/realtime_updates/realtime_updates_tests.rb +0 -187
  47. data/spec/koala/rest_api/rest_api_no_access_token_tests.rb +0 -94
  48. data/spec/koala/rest_api/rest_api_with_access_token_tests.rb +0 -36
  49. data/spec/koala_spec.rb +0 -18
  50. data/spec/koala_spec_helper.rb +0 -45
  51. data/spec/koala_spec_without_mocks.rb +0 -19
@@ -0,0 +1,221 @@
1
+ require 'spec_helper'
2
+
3
+ describe "Koala::Facebook::TestUsers" do
4
+ context "with access token" do
5
+ include LiveTestingDataHelper
6
+
7
+ before :all do
8
+ # get oauth data
9
+ @oauth_data = $testing_data["oauth_test_data"]
10
+ @app_id = @oauth_data["app_id"]
11
+ @secret = @oauth_data["secret"]
12
+ @app_access_token = @oauth_data["app_access_token"]
13
+
14
+ # check OAuth data
15
+ unless @app_id && @secret && @app_access_token
16
+ raise Exception, "Must supply OAuth app id, secret, app_access_token, and callback to run live subscription tests!"
17
+ end
18
+
19
+ @is_mock = defined?(Koala::IS_MOCK) && Koala::IS_MOCK
20
+ end
21
+
22
+ describe "when initializing" do
23
+ # basic initialization
24
+ it "should initialize properly with an app_id and an app_access_token" do
25
+ test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :app_access_token => @app_access_token)
26
+ test_users.should be_a(Koala::Facebook::TestUsers)
27
+ end
28
+
29
+ # init with secret / fetching the token
30
+ it "should initialize properly with an app_id and a secret" do
31
+ test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
32
+ test_users.should be_a(Koala::Facebook::TestUsers)
33
+ end
34
+
35
+ it "should use the OAuth class to fetch a token when provided an app_id and a secret" do
36
+ oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
37
+ token = oauth.get_app_access_token
38
+ oauth.should_receive(:get_app_access_token).and_return(token)
39
+ Koala::Facebook::OAuth.should_receive(:new).with(@app_id, @secret).and_return(oauth)
40
+ test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
41
+ end
42
+ end
43
+
44
+ describe "when used without network" do
45
+ before :each do
46
+ @test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
47
+ end
48
+
49
+ # TEST USER MANAGEMENT
50
+ it "should create a test user when not given installed" do
51
+ result = @test_users.create(false)
52
+ @temporary_object_id = result["id"]
53
+ result.should be_a(Hash)
54
+ (result["id"] && result["access_token"] && result["login_url"]).should
55
+ end
56
+
57
+ it "should create a test user when not given installed, ignoring permissions" do
58
+ result = @test_users.create(false, "read_stream")
59
+ @temporary_object_id = result["id"]
60
+ result.should be_a(Hash)
61
+ (result["id"] && result["access_token"] && result["login_url"]).should
62
+ end
63
+
64
+ it "should accept permissions as a string" do
65
+ @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
66
+ result = @test_users.create(true, "read_stream,publish_stream")
67
+ end
68
+
69
+ it "should accept permissions as an array" do
70
+ @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
71
+ result = @test_users.create(true, ["read_stream", "publish_stream"])
72
+ end
73
+
74
+ it "should create a test user when given installed and a permission" do
75
+ result = @test_users.create(true, "read_stream")
76
+ @temporary_object_id = result["id"]
77
+ result.should be_a(Hash)
78
+ (result["id"] && result["access_token"] && result["login_url"]).should
79
+ end
80
+
81
+ it "lets you specify other graph arguments, like uid and access token" do
82
+ args = {:uid => "some test user ID", :owner_access_token => "some owner access token"}
83
+ @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including(args), anything, anything)
84
+ @test_users.create(true, nil, args)
85
+ end
86
+
87
+ it "lets you specify http options that get passed through to the graph call" do
88
+ options = {:some_http_option => true}
89
+ @test_users.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
90
+ @test_users.create(true, nil, {}, options)
91
+ end
92
+
93
+ describe "with a user to delete" do
94
+ before :each do
95
+ @user1 = @test_users.create(true, "read_stream")
96
+ @user2 = @test_users.create(true, "read_stream,user_interests")
97
+ end
98
+
99
+ after :each do
100
+ @test_users.delete(@user1) if @user1
101
+ @test_users.delete(@user2) if @user2
102
+ end
103
+
104
+ it "should delete a user by id" do
105
+ @test_users.delete(@user1['id']).should be_true
106
+ @user1 = nil
107
+ end
108
+
109
+ it "should delete a user by hash" do
110
+ @test_users.delete(@user2).should be_true
111
+ @user2 = nil
112
+ end
113
+
114
+ it "should not delete users when provided a false ID" do
115
+ lambda { @test_users.delete("#{@user1['id']}1") }.should raise_exception(Koala::Facebook::APIError)
116
+ end
117
+ end
118
+
119
+ describe "with delete_all" do
120
+ it "should delete all users found by the list commnand" do
121
+ array = [1, 2, 3]
122
+ @test_users.should_receive(:list).and_return(array)
123
+ array.each {|i| @test_users.should_receive(:delete).with(i) }
124
+ @test_users.delete_all
125
+ end
126
+ end
127
+
128
+ describe "with existing users" do
129
+ before :each do
130
+ @user1 = @test_users.create(true, "read_stream")
131
+ @user2 = @test_users.create(true, "read_stream,user_interests")
132
+ end
133
+
134
+ after :each do
135
+ @test_users.delete(@user1)
136
+ @test_users.delete(@user2)
137
+ end
138
+
139
+ it "should list test users" do
140
+ result = @test_users.list
141
+ result.should be_an(Array)
142
+ first_user, second_user = result[0], result[1]
143
+ (first_user["id"] && first_user["access_token"] && first_user["login_url"]).should
144
+ (second_user["id"] && second_user["access_token"] && second_user["login_url"]).should
145
+ end
146
+
147
+ it "should make two users into friends with string hashes" do
148
+ result = @test_users.befriend(@user1, @user2)
149
+ result.should be_true
150
+ end
151
+
152
+ it "should make two users into friends with symbol hashes" do
153
+ new_user_1 = {}
154
+ @user1.each_pair {|k, v| new_user_1[k.to_sym] = v}
155
+ new_user_2 = {}
156
+ @user2.each_pair {|k, v| new_user_2[k.to_sym] = v}
157
+
158
+ result = @test_users.befriend(new_user_1, new_user_2)
159
+ result.should be_true
160
+ end
161
+
162
+ it "should not accept user IDs anymore" do
163
+ lambda { @test_users.befriend(@user1["id"], @user2["id"]) }.should raise_exception
164
+ end
165
+ end # with existing users
166
+
167
+ end # when used without network
168
+
169
+ describe "when creating a network of friends" do
170
+ before :each do
171
+ @test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
172
+ @network = []
173
+
174
+ if @is_mock
175
+ id_counter = 999999900
176
+ @test_users.stub!(:create).and_return do
177
+ id_counter += 1
178
+ {"id" => id_counter, "access_token" => @token, "login_url" => "https://www.facebook.com/platform/test_account.."}
179
+ end
180
+ @test_users.stub!(:befriend).and_return(true)
181
+ @test_users.stub!(:delete).and_return(true)
182
+ end
183
+ end
184
+
185
+ describe "tests that create users" do
186
+ before :each do
187
+ test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
188
+ test_users.delete_all
189
+ end
190
+
191
+ after :each do
192
+ test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
193
+ test_users.delete_all
194
+ end
195
+
196
+ it "should create a 5 person network" do
197
+ size = 5
198
+ @network = @test_users.create_network(size)
199
+ @network.should be_a(Array)
200
+ @network.size.should == size
201
+ end
202
+ end
203
+
204
+ it "should limit to a 50 person network" do
205
+ @test_users.should_receive(:create).exactly(50).times
206
+ @test_users.stub!(:befriend)
207
+ @network = @test_users.create_network(51)
208
+ end
209
+
210
+ it "should pass on the installed and permissions parameters to create" do
211
+ perms = ["read_stream", "offline_access"]
212
+ installed = false
213
+ count = 25
214
+ @test_users.should_receive(:create).exactly(count).times.with(installed, perms)
215
+ @test_users.stub!(:befriend)
216
+ @network = @test_users.create_network(count, installed, perms)
217
+ end
218
+
219
+ end # when creating network
220
+ end
221
+ end # describe Koala TestUsers
@@ -0,0 +1,151 @@
1
+ # fake MIME::Types
2
+ module Koala::MIME
3
+ module Types
4
+ def self.type_for(type)
5
+ # this should be faked out in tests
6
+ nil
7
+ end
8
+ end
9
+ end
10
+
11
+ describe "Koala::UploadableIO" do
12
+ describe "the constructor" do
13
+ describe "when given a file path" do
14
+ before(:each) do
15
+ @koala_io_params = [File.open(BEACH_BALL_PATH)]
16
+ end
17
+
18
+ describe "and a content type" do
19
+ before :each do
20
+ @koala_io_params.concat([stub("image/jpg")])
21
+ end
22
+
23
+ it "should return an UploadIO with the same file path" do
24
+ stub_path = @koala_io_params[0] = "/stub/path/to/file"
25
+ Koala::UploadableIO.new(*@koala_io_params).io_or_path.should == stub_path
26
+ end
27
+
28
+ it "should return an UploadIO with the same content type" do
29
+ stub_type = @koala_io_params[1] = stub('Content Type')
30
+ Koala::UploadableIO.new(*@koala_io_params).content_type.should == stub_type
31
+ end
32
+ end
33
+
34
+ describe "and no content type" do
35
+ it_should_behave_like "determining a mime type"
36
+ end
37
+ end
38
+
39
+ describe "when given a File object" do
40
+ before(:each) do
41
+ @koala_io_params = [File.open(BEACH_BALL_PATH)]
42
+ end
43
+
44
+ describe "and a content type" do
45
+ before :each do
46
+ @koala_io_params.concat(["image/jpg"])
47
+ end
48
+
49
+ it "should return an UploadIO with the same io" do
50
+ Koala::UploadableIO.new(*@koala_io_params).io_or_path.should == @koala_io_params[0]
51
+ end
52
+
53
+ it "should return an UplaodIO with the same content_type" do
54
+ content_stub = @koala_io_params[1] = stub('Content Type')
55
+ Koala::UploadableIO.new(*@koala_io_params).content_type.should == content_stub
56
+ end
57
+ end
58
+
59
+ describe "and no content type" do
60
+ it_should_behave_like "determining a mime type"
61
+ end
62
+ end
63
+
64
+ describe "when given a Rails 3 ActionDispatch::Http::UploadedFile" do
65
+ before(:each) do
66
+ @tempfile = stub('Tempfile', :path => "foo")
67
+ @uploaded_file = stub('ActionDispatch::Http::UploadedFile',
68
+ :content_type => true,
69
+ :tempfile => @tempfile
70
+ )
71
+
72
+ @tempfile.stub!(:respond_to?).with(:path).and_return(true)
73
+ end
74
+
75
+ it "should get the content type via the content_type method" do
76
+ expected_content_type = stub('Content Type')
77
+ @uploaded_file.should_receive(:content_type).and_return(expected_content_type)
78
+ Koala::UploadableIO.new(@uploaded_file).content_type.should == expected_content_type
79
+ end
80
+
81
+ it "should get the path from the tempfile associated with the UploadedFile" do
82
+ expected_path = stub('Tempfile')
83
+ @tempfile.should_receive(:path).and_return(expected_path)
84
+ Koala::UploadableIO.new(@uploaded_file).io_or_path.should == expected_path
85
+ end
86
+ end
87
+
88
+ describe "when given a Sinatra file parameter hash" do
89
+ before(:each) do
90
+ @file_hash = {
91
+ :type => "type",
92
+ :tempfile => "Tempfile"
93
+ }
94
+ end
95
+
96
+ it "should get the content type from the :type key" do
97
+ expected_content_type = stub('Content Type')
98
+ @file_hash[:type] = expected_content_type
99
+
100
+ uploadable = Koala::UploadableIO.new(@file_hash)
101
+ uploadable.content_type.should == expected_content_type
102
+ end
103
+
104
+ it "should get the io_or_path from the :tempfile key" do
105
+ expected_file = stub('File')
106
+ @file_hash[:tempfile] = expected_file
107
+
108
+ uploadable = Koala::UploadableIO.new(@file_hash)
109
+ uploadable.io_or_path.should == expected_file
110
+ end
111
+ end
112
+
113
+ describe "for files with with recognizable MIME types" do
114
+ # what that means is tested below
115
+ it "should accept a file object alone" do
116
+ params = [BEACH_BALL_PATH]
117
+ lambda { Koala::UploadableIO.new(*params) }.should_not raise_exception(Koala::KoalaError)
118
+ end
119
+
120
+ it "should accept a file path alone" do
121
+ params = [BEACH_BALL_PATH]
122
+ lambda { Koala::UploadableIO.new(*params) }.should_not raise_exception(Koala::KoalaError)
123
+ end
124
+ end
125
+ end
126
+
127
+ describe "getting an UploadableIO" do
128
+ before(:each) do
129
+ @upload_io = stub("UploadIO")
130
+ UploadIO.stub!(:new).with(anything, anything, anything).and_return(@upload_io)
131
+ end
132
+
133
+ it "should call the constructor with the content type, file name, and a dummy file name" do
134
+ UploadIO.should_receive(:new).with(BEACH_BALL_PATH, "content/type", anything).and_return(@upload_io)
135
+ Koala::UploadableIO.new(BEACH_BALL_PATH, "content/type").to_upload_io.should == @upload_io
136
+ end
137
+ end
138
+
139
+ describe "getting a file" do
140
+ it "should return the File if initialized with a file" do
141
+ f = File.new(BEACH_BALL_PATH)
142
+ Koala::UploadableIO.new(f).to_file.should == f
143
+ end
144
+
145
+ it "should open up and return a file corresponding to the path if io_or_path is a path" do
146
+ result = stub("File")
147
+ File.should_receive(:open).with(BEACH_BALL_PATH).and_return(result)
148
+ Koala::UploadableIO.new(BEACH_BALL_PATH).to_file.should == result
149
+ end
150
+ end
151
+ end # describe UploadableIO
Binary file
@@ -4,19 +4,19 @@
4
4
  # Just remember to update all fields!
5
5
 
6
6
  # You must supply this value yourself to test the GraphAPI class.
7
- # Your OAuth token should have publish_stream and read_stream permissions.
8
- oauth_token: 119908831367602|2.5GL0_XdFnxzqsiXeHxJ_FQ__.3600.1286535600-2905623|24AaBQnKkMvvMlNNKdJn4GxRWWQ
7
+ # Your OAuth token should have publish_stream, read_stream, and user_photos permissions.
8
+ oauth_token:
9
9
 
10
10
  # for testing the OAuth class
11
11
  # baseline app
12
12
  oauth_test_data:
13
13
  # You must supply this value yourself, since they will expire.
14
- code: 2.5GL0_XdFnxzqsiXeHxJ_FQ__.3600.1286535600-2905623|Hae8o6zcuXr9E_UXm0LdoCN4ML8
14
+ code:
15
15
  # easiest way to get session keys: use multiple test accounts with the Javascript login at http://oauth.twoalex.com
16
- session_key: 2.5GL0_XdFnxzqsiXeHxJ_FQ__.3600.1286535600-2905623
16
+ session_key:
17
17
  multiple_session_keys:
18
- - 2.5GL0_XdFnxzqsiXeHxJ_FQ__.3600.1286535600-2905623
19
- - 2.5GL0_XdFnxzqsiXeHxJ_FQ__.3600.1286535600-2905623
18
+ -
19
+ -
20
20
 
21
21
  # These values will work out of the box
22
22
  app_id: 119908831367602
@@ -35,17 +35,21 @@ oauth_test_data:
35
35
  # note: I've revoked the offline access for security reasons, so you can't make calls against this :)
36
36
  fbs_119908831367602: '"access_token=119908831367602|08170230801eb225068e7a70-2905623|Q3LDCYYF8CX9cstxnZLsxiR0nwg.&expires=0&secret=78abaee300b392e275072a9f2727d436&session_key=08170230801eb225068e7a70-2905623&sig=423b8aa4b6fa1f9a571955f8e929d567&uid=2905623"'
37
37
 
38
- # These values will work out of the box
39
- # They're from Facebook's example at http://developers.facebook.com/docs/authentication/canvas
38
+ # These values from the OAuth Playground (see above) will work out of the box
40
39
  # You can update this to live data if desired
41
40
  # request_secret is optional and will fall back to the secret above if absent
42
- request_secret: "secret"
43
- signed_request: "vlXgu64BQGFSQrY0ZcJBZASMvYvTHu9GQ0YM9rjPSso.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsIjAiOiJwYXlsb2FkIn0"
44
- signed_request_result:
45
- "0": payload
41
+ signed_params: "zWRm0gd5oHW_jzXP_WA9CirO7c5CLHotn-SKRqH2NmU.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsImV4cGlyZXMiOjEzMDE5MjIwMDAsImlzc3VlZF9hdCI6MTMwMTkxNzI5OSwib2F1dGhfdG9rZW4iOiIxMTk5MDg4MzEzNjc2MDJ8Mi56VkZfNk5yTUVMSHVKYTRnSVU5dEt3X18uMzYwMC4xMzAxOTIyMDAwLTI5MDU2MjN8emdxUHNyMkJHOUxvT0s5a2VrR2dSVVJaeDBrIiwidXNlciI6eyJjb3VudHJ5IjoiZGUiLCJsb2NhbGUiOiJkZV9ERSIsImFnZSI6eyJtaW4iOjIxfX0sInVzZXJfaWQiOiIyOTA1NjIzIn0"
42
+ signed_params_result:
43
+ expires: 1301922000
46
44
  algorithm: HMAC-SHA256
47
-
48
-
45
+ user_id: "2905623"
46
+ oauth_token: 119908831367602|2.zVF_6NrMELHuJa4gIU9tKw__.3600.1301922000-2905623|zgqPsr2BG9LoOK9kekGgRURZx0k
47
+ user:
48
+ country: de
49
+ locale: de_DE
50
+ age:
51
+ min: 21
52
+ issued_at: 1301917299
49
53
 
50
54
  subscription_test_data:
51
55
  subscription_path: http://oauth.twoalex.com/subscriptions