blippex_api 1.0.0.pre.8 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -13
- data/README.md +3 -152
- metadata +6 -5
checksums.yaml
CHANGED
@@ -1,15 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
|
5
|
-
data.tar.gz: !binary |-
|
6
|
-
YjUyNzIwZWNlYmFhMTc2M2Y0ZjJiODBmZWM0MWU5NDNhY2RkNDVkOQ==
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b44e60f2e0e6e2fbe9cfe3b0b312162f96ac1a77
|
4
|
+
data.tar.gz: f5bec8796b67cd458fac454ffee86f8240ecf7a3
|
7
5
|
SHA512:
|
8
|
-
metadata.gz:
|
9
|
-
|
10
|
-
MzhkMGY1ZjY0OTE5MjY5ZjI3MjQyOTdkNjNmNGRjMDdiMzY2ZDFiNTgxZTEw
|
11
|
-
Yzc0NDM5NjcxOWM0YTU5MDZhYjI0MWMzODA1ZTg2Y2Q2MDdkMGM=
|
12
|
-
data.tar.gz: !binary |-
|
13
|
-
ZWRkYjNkNTUzZTI5ODkzZTNjMTZmYWZiZjI3MjU5NjdiNDRlZmYxMGJkOTY1
|
14
|
-
NjVhMThkMmZlYWEyYTAxNDkzMjdmMDk2MDVlYzEyNjM5NzU2NmZiNzlhNjAy
|
15
|
-
YmNiZTY1Y2Y2NzljOTI2YWFkMzdhYTQ4NjI1NmRjMGIwNTNjMDE=
|
6
|
+
metadata.gz: f2d33fee640364772335ae6235e09213f9e627d18525a3449ee6958cb992871eee44cb8be49133a08508a789940b4a6e8cf10418e0b69ec27f7670277878f550
|
7
|
+
data.tar.gz: c00dac509cc0a40d4ba72b587049cdb926e8b96e6698eeeb698b090e4b39a375ed2257c521810f180b164604425b6ac98d13056e7864a8d74fe4957cd124c11a
|
data/README.md
CHANGED
@@ -1,153 +1,4 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
[![Build Status](https://travis-ci.org/jonathanchrisp/blippex_api.png?branch=master)](https://travis-ci.org/jonathanchrisp/blippex_api)
|
4
|
-
[![Dependency Status](https://gemnasium.com/jonathanchrisp/blippex_api.png)](https://gemnasium.com/jonathanchrisp/blippex_api)
|
5
|
-
[![Code Climate](https://codeclimate.com/github/jonathanchrisp/blippex_api.png)](https://codeclimate.com/github/jonathanchrisp/blippex_api)
|
6
|
-
[![Coverage Status](https://coveralls.io/repos/jonathanchrisp/blippex_api/badge.png?branch=master)](https://coveralls.io/r/jonathanchrisp/blippex_api?branch=master)
|
1
|
+
blippexapi
|
2
|
+
==========
|
7
3
|
|
8
|
-
|
9
|
-
A ruby wrapper for the blippex search engine made bythe people, forthe people.
|
10
|
-
|
11
|
-
You can find out more about the Blippex API [here](https://archify.atlassian.net/wiki/display/blippexAPI/api.blippex.org).
|
12
|
-
|
13
|
-
## Documentation
|
14
|
-
* Original documenation: <https://archify.atlassian.net/wiki/display/blippexAPI/api.blippex.org>
|
15
|
-
* Gem documentation: <http://rubydoc.info/gems/blippex_api>
|
16
|
-
|
17
|
-
## Getting Started
|
18
|
-
In order to be able to send API requests you'll first need to install the `blippex_api` gem.
|
19
|
-
|
20
|
-
```ruby
|
21
|
-
gem install blippex_api
|
22
|
-
```
|
23
|
-
|
24
|
-
Once you have completed the steps above, you can now create an instance of a `BlippexAPI::Client`:
|
25
|
-
|
26
|
-
```ruby
|
27
|
-
require 'blippex_api'
|
28
|
-
api = BlippexAPI::Client.new
|
29
|
-
```
|
30
|
-
|
31
|
-
If you now look at your `BlippexAPI` object instance it will be similar to the following:
|
32
|
-
|
33
|
-
```ruby
|
34
|
-
<BlippexAPI::Client:0x007fe9a23055f0
|
35
|
-
@adapter=:net_http,
|
36
|
-
@api_endpoint="https://api.blippex.org/",
|
37
|
-
@user_agent="BlippexAPI Ruby Gem 1.0.0">
|
38
|
-
```
|
39
|
-
|
40
|
-
## Example requests
|
41
|
-
Now that you have an `BlippexAPI::Client` instance you can now make requests.
|
42
|
-
|
43
|
-
### info endpoint
|
44
|
-
|
45
|
-
```ruby
|
46
|
-
api.info
|
47
|
-
```
|
48
|
-
|
49
|
-
The response is returned within a `Hashie::Mash` instance.
|
50
|
-
|
51
|
-
```ruby
|
52
|
-
{
|
53
|
-
"total_page_count"=>5654101,
|
54
|
-
"total_pageview_count"=>8662559,
|
55
|
-
"yesterday_page_count"=>55708,
|
56
|
-
"yesterday_pageview_count"=>67842,
|
57
|
-
"search_count_history"=> [
|
58
|
-
{
|
59
|
-
"date"=>"2013-09-24T00:00:00+00:00",
|
60
|
-
"value"=>"83115"
|
61
|
-
},
|
62
|
-
{
|
63
|
-
"date"=>"2013-09-23T00:00:00+00:00",
|
64
|
-
"value"=>"70182"
|
65
|
-
}
|
66
|
-
]
|
67
|
-
}
|
68
|
-
```
|
69
|
-
|
70
|
-
### search endpoint
|
71
|
-
|
72
|
-
```ruby
|
73
|
-
api.search :q => 'Lakers', :w => 20, :d => 2, :highlight => 1, :limit => 1, :offset => 1
|
74
|
-
```
|
75
|
-
|
76
|
-
As above, the response is returned within a `Hashie::Mash` instance.
|
77
|
-
|
78
|
-
```ruby
|
79
|
-
{
|
80
|
-
"request"=> {
|
81
|
-
"days"=>2,
|
82
|
-
"weight"=>20,
|
83
|
-
"limit"=>1,
|
84
|
-
"offset"=>1,
|
85
|
-
"query"=>"Lakers"
|
86
|
-
},
|
87
|
-
"total"=>31,
|
88
|
-
"hits_displayed"=>1,
|
89
|
-
"results"=> [
|
90
|
-
{
|
91
|
-
"_id"=>"1d431326999324b8eccb85b7399553f4",
|
92
|
-
"_source"=>"Blippex",
|
93
|
-
"url"=>"http://about.me/claresayas",
|
94
|
-
"last_seen_at"=>"2013-09-24T15:17:25-07:00",
|
95
|
-
"language"=>"en",
|
96
|
-
"title"=>"Clare Sayas (claresayas) on about.me",
|
97
|
-
"highlight"=>
|
98
|
-
" of the community managers for EdelmanSV.\nOn a mission to help entrepreuners find their voice and advance the field of public engagement.\n<mark>Lakers</mark> fan, film/tv enthusiast, relentless home",
|
99
|
-
"score"=> {
|
100
|
-
"score_raw_elasticsearch"=>0,
|
101
|
-
"score_raw_dwell"=>4.3298473876598,
|
102
|
-
"sum_time_spend"=>38,
|
103
|
-
"sum_visits"=>3,
|
104
|
-
"score_clean_elasticsearch"=>0,
|
105
|
-
"score_clean_dwell"=>0.86449725527946,
|
106
|
-
"score_final"=>0.69159780422356
|
107
|
-
}
|
108
|
-
}
|
109
|
-
],
|
110
|
-
"total_pages_in_db"=>5687567
|
111
|
-
}
|
112
|
-
|
113
|
-
```
|
114
|
-
|
115
|
-
### ratelimitstatus endpoint
|
116
|
-
|
117
|
-
```ruby
|
118
|
-
api.rate_limit_status
|
119
|
-
```
|
120
|
-
|
121
|
-
As above, the response is returned within a `Hashie::Mash` instance.
|
122
|
-
|
123
|
-
```ruby
|
124
|
-
{
|
125
|
-
"ip"=>"00.0.000.00",
|
126
|
-
"data"=> {
|
127
|
-
"info"=> {
|
128
|
-
"remaining"=>997,
|
129
|
-
"reset"=>1380136296,
|
130
|
-
"limit"=>1000
|
131
|
-
},
|
132
|
-
"search"=> {
|
133
|
-
"remaining"=>3587,
|
134
|
-
"reset"=>1380136296,
|
135
|
-
"limit"=>3600
|
136
|
-
}
|
137
|
-
}
|
138
|
-
}
|
139
|
-
```
|
140
|
-
|
141
|
-
To find out more information about `Hashie` please visit the following link: <https://github.com/intridea/hashie>.
|
142
|
-
|
143
|
-
## Tests
|
144
|
-
There are a number of unit tests which are included as part of this project, please run:
|
145
|
-
|
146
|
-
```ruby
|
147
|
-
rspec spec
|
148
|
-
```
|
149
|
-
|
150
|
-
Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
|
151
|
-
|
152
|
-
## Feedback
|
153
|
-
I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com.
|
4
|
+
A ruby wrapper for the blippex search engine made bythe people, forthe people
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: blippex_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.0
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Jonathan Chrisp
|
@@ -104,20 +104,21 @@ require_paths:
|
|
104
104
|
- lib
|
105
105
|
required_ruby_version: !ruby/object:Gem::Requirement
|
106
106
|
requirements:
|
107
|
-
- -
|
107
|
+
- - '>='
|
108
108
|
- !ruby/object:Gem::Version
|
109
109
|
version: 1.9.2
|
110
110
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
111
111
|
requirements:
|
112
|
-
- -
|
112
|
+
- - '>='
|
113
113
|
- !ruby/object:Gem::Version
|
114
|
-
version:
|
114
|
+
version: '0'
|
115
115
|
requirements: []
|
116
116
|
rubyforge_project:
|
117
|
-
rubygems_version: 2.1.
|
117
|
+
rubygems_version: 2.1.2
|
118
118
|
signing_key:
|
119
119
|
specification_version: 4
|
120
120
|
summary: Blippex API ruby wrapper
|
121
121
|
test_files:
|
122
122
|
- spec/blippex_api_spec.rb
|
123
123
|
- spec/helper.rb
|
124
|
+
has_rdoc:
|