图像索引-GSA/asis-行业智能，新时代，新科技，新码农

<h1> ASIS Server </h1>
 <p> <a href="https://circleci.com/gh/GSA/asis"> <img src="https://circleci.com/gh/GSA/asis.svg?style=shield" alt="CircleCI" /> </a> <a href="https://codeclimate.com/github/GSA/asis"> <img src="https://codeclimate.com/github/GSA/asis/badges/gpa.svg" alt="Code Climate" /> </a> <a href="https://codeclimate.com/github/GSA/asis"> <img src="https://codeclimate.com/github/GSA/asis/badges/coverage.svg" alt="Test Coverage" /> </a> </p>
 <p> ASIS（高级社交图像搜索）索引Flickr和Instagram图像，并在两个索引之间提供搜索API。 </p>
 <h2>当前版本</h2>
 <p>您正在阅读ASIS API v1的文档。 </p>
 <h2>参与代码</h2>
 <p>运行图像搜索组件<a href="https://search.gov/"> Search.gov </a>的服务器代码在Github上。 <a href="https://github.com/GSA/oasis/fork">使用此repo </a>来添加其他数据集等功能，或修复错误。 </p>
 <h3> Ruby </h3>
 <p>此代码目前已针对<a href="http://www.ruby-lang.org/en/downloads/"> Ruby 2.3 </a>进行了测试。 </p>
 <h3>配置</h3>
 <ol>
 <li>复制<code>instagram.yml.example</code>到<code>instagram.yml</code>并使用您的Instagram凭据更新字段。 </li>
 <li>复制<code>flickr.yml.example</code>至<code>flickr.yml</code>并使用Flickr凭据更新字段。 </li>
 </ol>
 <h3> Gems </h3>
 <p>我们使用bundler来管理gem。您可以安装bundler和其他所需的宝石，如下所示：</p>
 <pre><code>gem install bundler
bundle install
</code></pre>
 <h3> Elasticsearch </h3>
 <p>我们正在使用<a href="http://www.elasticsearch.org/"> Elasticsearch </a>（＆gt; = 5.6.5）进行全文搜索。在Mac上，使用<a href="http://mxcl.github.com/homebrew/"> Homebrew </a>可以轻松安装。 </p>
 <pre><code>$ brew install elasticsearch@5.6
</code></pre>
 <p>否则，请按照<a href="http://www.elasticsearch.org/download/">说明</a>下载并运行它。 </p>
 <p>您通常可以保留elasticsearch.yml中的默认值，但以下情况除外：</p>
 <h4>脚本</h4>
 <p> <a href="https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting-security.html#security-script-source"> Elasticsearch 5.6中默认禁用脚本</a>。将<code>script.inline</code>和<code>script.stored</code>都设置为<code>true</code>：</p>
 <pre><code>script:
  inline: true
  stored: true
</code></pre>
 <h3> Elasticsearch with Docker </h3>
 <p>如果尚未安装Docker，请安装Docker。按照说明<a href="https://www.docker.com/community-edition">此处</a>在计算机上安装Docker后，从项目根目录运行以下命令</p>
 <pre><code>$ .docker/bin/elasticsearch-docker
</code></pre>
 <p>这将从docker.elastic.co下载包含elasticsearch = 5.6的docker镜像，运行它，并暴露端口9200＆amp; 9300到你的机器。您可以使用以下命令验证您的设置。 </p>
 <pre><code>$ curl localhost:9200
{
  "name" : ...random string...,
  "cluster_name" : "elasticsearch",
  "cluster_uuid" : ...uuid...
  "version" : {
    "number" : "5.6.5",
    "build_hash" : "6a37571",
    "build_timestamp" : "2017-12-04T07:50:10.466Z",
    "build_snapshot" : false,
    "lucene_version" : "6.6.1"
  },
  "tagline" : "You Know, for Search"
}
</code></pre>
 <h3> Redis </h3>
 <p> Sidekiq（见下文）使用<a href="http://redis.io"> Redis </a>，因此请确保已安装并运行。 </p>
 <h3>播种一些图像数据</h3>
 <p>您可以使用某些政府Flickr / Instagram配置文件和MRSS源来引导系统，以查看系统是否正常工作。样本列表在<code>config/instagram_profiles.csv</code>和<code>config/flickr_profiles.csv</code>以及<code>config/mrss_profiles.csv</code>中。 </p>
 <pre><code>bundle exec rake oasis:seed_profiles
</code></pre>
 <p>通过定期刷新最后一天的图像，可以使索引保持最新。要通过Rails控制台手动执行此操作：</p>
 <pre><code>FlickrPhotosImporter.refresh
InstagramPhotosImporter.refresh
MrssPhotosImporter.refresh
</code></pre>
 <p>只要</a>挂钩，Capistrano部署脚本就有<a href="https://github.com/javan/whenever">，因此这个刷新会在生产环境中通过cron自动进行。 </p>
 <h3>运行它</h3>
 <p>启动服务器并尝试全部。 </p>
 <pre><code>bundle exec rails s
</code></pre>
 <p>以下是您刚刚引导的配置文件。注意：Chrome可以很好地打印JSON响应。 </p>
 <p> <a href="http://localhost:3000/api/v1/instagram_profiles.json"> http：// localhost：3000 / api / v1 / instagram_profiles.json </a> </p>
 <p> <a href="http://localhost:3000/api/v1/flickr_profiles.json"> http：// localhost：3000 / api / v1 / flickr_profiles.json </a> </p>
 <p> <a href="http://localhost:3000/api/v1/mrss_profiles.json"> http：// localhost：3000 / api / v1 / mrss_profiles.json </a> </p>
 <p>您可以通过REST API手动添加新配置文件：</p>
 <pre><code>	curl -XPOST "http://localhost:3000/api/v1/instagram_profiles.json?username=deptofdefense&id=542835249"
	curl -XPOST "http://localhost:3000/api/v1/flickr_profiles.json?name=commercegov&id=61913304@N07&profile_type=user"
	curl -XPOST "http://localhost:3000/api/v1/mrss_profiles.json?url=http%3A%2F%2Fremotesensing.usgs.gov%2Fgallery%2Frss.php%3Fcat%3Dall"
</code></pre>
 <p> MRSS配置文件与Flickr和Instagram配置文件的工作方式略有不同。创建MRSS配置文件时，Oasis会为其分配一个短名称，您将在执行搜索时使用该名称。 POST请求的JSON结果如下所示：</p>
 <pre><code>  {
    "created_at": "2014-10-26T18:25:21.167+00:00",
    "updated_at": "2014-10-26T18:25:21.173+00:00",
    "name": "72",
    "id": "http:\/\/remotesensing.usgs.gov\/gallery\/rss.php?cat=all"
  }
</code></pre>
 <h3>异步作业处理</h3>
 <p>我们使用<a href="http://sidekiq.org"> Sidekiq </a>进行工作处理。您可以在此处查看排队的所有Flickr和Instagram作业：</p>
 <p> <a href="http://localhost:3000/sidekiq"> http：// localhost：3000 / sidekiq </a> </p>
 <p>启动索引编制过程：</p>
 <pre><code>bundle exec sidekiq
</code></pre>
 <p>在Rails控制台中，您可以使用Elasticsearch <a href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html">查询DSL </a>手动查询每个索引：</p>
 <pre><code>bin/rails c
InstagramPhoto.count
FlickrPhoto.count
MrssPhoto.count
InstagramPhoto.all(query:{term:{username:'usinterior'}})
FlickrPhoto.all(query:{term:{owner:'41555360@n03'}})
MrssPhoto.all(query:{term:{mrss_url:'http://remotesensing.usgs.gov/gallery/rss.php?cat=all'}})
</code></pre>
 <h3>参数</h3>
 <p>混合搜索API接受以下参数：</p>
 <ol>
 <li>查询</li>
 <li> flickr_groups（逗号分隔）</li>
 <li> flickr_users（逗号分隔）</li>
 <li> instagram_profiles（逗号分隔）</li>
 <li> mrss_names（以逗号分隔的Oasis指定名称列表）</li>
 <li>尺寸</li>
 <li>来自</li>
 </ol>
 <h3>结果</h3>
 <p>顶级JSON包含以下字段：</p>
 <ul>
 <li><code>total</code> </li>
 <li> <code>offset</code> </li>
 <li> <code>suggestion</code>：重写的拼写建议</li>
 <li> <code>results</code> </li>
 </ul>
 <p>每个结果都包含以下字段：</p>
 <ul>
 <li> <code>type</code>：FlickrPhoto | InstagramPhoto </li>
 <li> <code>title</code> </li>
 <li> <code>url</code> </li>
 <li> <code>thumbnail_url</code> </li>
 <li> <code>taken_at</code> </li>
 </ul>
 <h3> API版本控制</h3>
 <p>我们支持使用JSON格式的API版本控制。当前版本是v1。您可以指定特定的JSON API版本，如下所示：</p>
 <pre><code>curl "http://localhost:3000/api/v1/image.json?flickr_groups=1058319@N21&flickr_users=35067687@n04,24662369@n07&instagram_profiles=nasa&mrss_names=72,73&query=earth"
</code></pre>
 <h3>测试</h3>
 <p>这些服务器需要运行<a href="http://www.elasticsearch.org/"> Elasticsearch </a>服务器和<a href="http://redis.io"> Redis </a>服务器。 </p>
 <pre><code>bundle exec rspec
</code></pre>
 <h3>代码覆盖范围</h3>
 <p>我们跟踪代码库的测试覆盖率，以帮助确定我们可以编写更好的测试的区域，以及查看引入测试不良的代码的时间。 </p>
 <p>运行测试后，打开<code>coverage/index.html</code>查看报告。 </p>
 <p>点击有＆lt;的文件100％覆盖率，以查看未行使的线路。 </p>
 <h2>代码示例</h2>
 <p>我们“吃自己的狗粮”并使用此ASIS API在使用<a href="https://search.gov/"> Search.gov </a>的政府网站上显示图像结果。 </p>
 <p>在DOI.gov </a>上查看搜索<a href="https://search.doi.gov/search/images?affiliate=doi.gov&query=moon"> <em> moon </em>的搜索结果。 </p>
 <h2>反馈</h2>
 <p>您可以通过<a href="https://github.com/GSA/oasis/issues"> Github Issues </a>发送反馈。 </p>
 <hr />
 <p> <a href="https://github.com/loren"> Loren Siebert </a>和<a href="http://github.com/GSA/oasis/contributors">贡献者</a>。 </p>